home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 21 / Cream of the Crop 21 (Terry Blount) (October 1996).iso / os2 / e33el2.zip / emacs / 19.33 / lisp / bytecomp.el < prev    next >
Text File  |  1996-03-22  |  132KB  |  3,388 lines

  1. ;;; bytecomp.el --- compilation of Lisp code into byte code.
  2.  
  3. ;; Copyright (C) 1985, 1986, 1987, 1992, 1994 Free Software Foundation, Inc.
  4.  
  5. ;; Author: Jamie Zawinski <jwz@lucid.com>
  6. ;;    Hallvard Furuseth <hbf@ulrik.uio.no>
  7. ;; Keywords: internal
  8.  
  9. ;; Subsequently modified by RMS.
  10.  
  11. ;;; This version incorporates changes up to version 2.10 of the 
  12. ;;; Zawinski-Furuseth compiler.
  13. (defconst byte-compile-version "FSF 2.10")
  14.  
  15. ;; This file is part of GNU Emacs.
  16.  
  17. ;; GNU Emacs is free software; you can redistribute it and/or modify
  18. ;; it under the terms of the GNU General Public License as published by
  19. ;; the Free Software Foundation; either version 2, or (at your option)
  20. ;; any later version.
  21.  
  22. ;; GNU Emacs is distributed in the hope that it will be useful,
  23. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  24. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25. ;; GNU General Public License for more details.
  26.  
  27. ;; You should have received a copy of the GNU General Public License
  28. ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  29. ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  30. ;; Boston, MA 02111-1307, USA.
  31.  
  32. ;;; Commentary:
  33.  
  34. ;; The Emacs Lisp byte compiler.  This crunches lisp source into a sort
  35. ;; of p-code which takes up less space and can be interpreted faster.
  36. ;; The user entry points are byte-compile-file and byte-recompile-directory.
  37.  
  38. ;;; Code:
  39.  
  40. ;; ========================================================================
  41. ;; Entry points:
  42. ;;    byte-recompile-directory, byte-compile-file,
  43. ;;     batch-byte-compile, batch-byte-recompile-directory,
  44. ;;    byte-compile, compile-defun,
  45. ;;    display-call-tree
  46. ;; (byte-compile-buffer and byte-compile-and-load-file were turned off
  47. ;;  because they are not terribly useful and get in the way of completion.)
  48.  
  49. ;; This version of the byte compiler has the following improvements:
  50. ;;  + optimization of compiled code:
  51. ;;    - removal of unreachable code;
  52. ;;    - removal of calls to side-effectless functions whose return-value
  53. ;;      is unused;
  54. ;;    - compile-time evaluation of safe constant forms, such as (consp nil)
  55. ;;      and (ash 1 6);
  56. ;;    - open-coding of literal lambdas;
  57. ;;    - peephole optimization of emitted code;
  58. ;;    - trivial functions are left uncompiled for speed.
  59. ;;  + support for inline functions;
  60. ;;  + compile-time evaluation of arbitrary expressions;
  61. ;;  + compile-time warning messages for:
  62. ;;    - functions being redefined with incompatible arglists;
  63. ;;    - functions being redefined as macros, or vice-versa;
  64. ;;    - functions or macros defined multiple times in the same file;
  65. ;;    - functions being called with the incorrect number of arguments;
  66. ;;    - functions being called which are not defined globally, in the 
  67. ;;      file, or as autoloads;
  68. ;;    - assignment and reference of undeclared free variables;
  69. ;;    - various syntax errors;
  70. ;;  + correct compilation of nested defuns, defmacros, defvars and defsubsts;
  71. ;;  + correct compilation of top-level uses of macros;
  72. ;;  + the ability to generate a histogram of functions called.
  73.  
  74. ;; User customization variables:
  75. ;;
  76. ;; byte-compile-verbose    Whether to report the function currently being
  77. ;;                compiled in the minibuffer;
  78. ;; byte-optimize        Whether to do optimizations; this may be 
  79. ;;                t, nil, 'source, or 'byte;
  80. ;; byte-optimize-log        Whether to report (in excruciating detail) 
  81. ;;                exactly which optimizations have been made.
  82. ;;                This may be t, nil, 'source, or 'byte;
  83. ;; byte-compile-error-on-warn    Whether to stop compilation when a warning is
  84. ;;                produced;
  85. ;; byte-compile-delete-errors    Whether the optimizer may delete calls or
  86. ;;                variable references that are side-effect-free
  87. ;;                except that they may return an error.
  88. ;; byte-compile-generate-call-tree    Whether to generate a histogram of
  89. ;;                function calls.  This can be useful for 
  90. ;;                finding unused functions, as well as simple
  91. ;;                performance metering.
  92. ;; byte-compile-warnings    List of warnings to issue, or t.  May contain
  93. ;;                'free-vars (references to variables not in the
  94. ;;                        current lexical scope)
  95. ;;                'unresolved (calls to unknown functions)
  96. ;;                'callargs  (lambda calls with args that don't
  97. ;;                        match the lambda's definition)
  98. ;;                'redefine  (function cell redefined from
  99. ;;                        a macro to a lambda or vice versa,
  100. ;;                        or redefined to take other args)
  101. ;;                'obsolete  (obsolete variables and functions)
  102. ;; byte-compile-compatibility    Whether the compiler should
  103. ;;                generate .elc files which can be loaded into
  104. ;;                generic emacs 18.
  105. ;; emacs-lisp-file-regexp    Regexp for the extension of source-files;
  106. ;;                see also the function byte-compile-dest-file.
  107.  
  108. ;; New Features:
  109. ;;
  110. ;;  o    The form `defsubst' is just like `defun', except that the function
  111. ;;    generated will be open-coded in compiled code which uses it.  This
  112. ;;    means that no function call will be generated, it will simply be
  113. ;;    spliced in.  Lisp functions calls are very slow, so this can be a
  114. ;;    big win.
  115. ;;
  116. ;;    You can generally accomplish the same thing with `defmacro', but in
  117. ;;    that case, the defined procedure can't be used as an argument to
  118. ;;    mapcar, etc.
  119. ;;
  120. ;;  o    You can also open-code one particular call to a function without
  121. ;;    open-coding all calls.  Use the 'inline' form to do this, like so:
  122. ;;
  123. ;;        (inline (foo 1 2 3))    ;; `foo' will be open-coded
  124. ;;    or...
  125. ;;        (inline            ;;  `foo' and `baz' will be 
  126. ;;         (foo 1 2 3 (bar 5))    ;; open-coded, but `bar' will not.
  127. ;;         (baz 0))
  128. ;;
  129. ;;  o    It is possible to open-code a function in the same file it is defined
  130. ;;    in without having to load that file before compiling it.  the
  131. ;;    byte-compiler has been modified to remember function definitions in
  132. ;;    the compilation environment in the same way that it remembers macro
  133. ;;    definitions.
  134. ;;
  135. ;;  o  Forms like ((lambda ...) ...) are open-coded.
  136. ;;
  137. ;;  o  The form `eval-when-compile' is like progn, except that the body
  138. ;;     is evaluated at compile-time.  When it appears at top-level, this
  139. ;;     is analogous to the Common Lisp idiom (eval-when (compile) ...).
  140. ;;     When it does not appear at top-level, it is similar to the
  141. ;;     Common Lisp #. reader macro (but not in interpreted code).
  142. ;;
  143. ;;  o  The form `eval-and-compile' is similar to eval-when-compile, but
  144. ;;    the whole form is evalled both at compile-time and at run-time.
  145. ;;
  146. ;;  o  The command compile-defun is analogous to eval-defun.
  147. ;;
  148. ;;  o  If you run byte-compile-file on a filename which is visited in a 
  149. ;;     buffer, and that buffer is modified, you are asked whether you want
  150. ;;     to save the buffer before compiling.
  151. ;;
  152. ;;  o  byte-compiled files now start with the string `;ELC'.
  153. ;;     Some versions of `file' can be customized to recognize that.
  154.  
  155. (require 'backquote)
  156.  
  157. (or (fboundp 'defsubst)
  158.     ;; This really ought to be loaded already!
  159.     (load-library "byte-run"))
  160.  
  161. ;;; The feature of compiling in a specific target Emacs version
  162. ;;; has been turned off because compile time options are a bad idea.
  163. (defmacro byte-compile-single-version () nil)
  164. (defmacro byte-compile-version-cond (cond) cond)
  165.  
  166. ;;; The crud you see scattered through this file of the form
  167. ;;;   (or (and (boundp 'epoch::version) epoch::version)
  168. ;;;      (string-lessp emacs-version "19"))
  169. ;;; is because the Epoch folks couldn't be bothered to follow the
  170. ;;; normal emacs version numbering convention.
  171.  
  172. ;; (if (byte-compile-version-cond
  173. ;;      (or (and (boundp 'epoch::version) epoch::version)
  174. ;;      (string-lessp emacs-version "19")))
  175. ;;     (progn
  176. ;;       ;; emacs-18 compatibility.
  177. ;;       (defvar baud-rate (baud-rate))    ;Define baud-rate if it's undefined
  178. ;; 
  179. ;;       (if (byte-compile-single-version)
  180. ;;       (defmacro byte-code-function-p (x) "Emacs 18 doesn't have these." nil)
  181. ;;     (defun byte-code-function-p (x) "Emacs 18 doesn't have these." nil))
  182. ;; 
  183. ;;       (or (and (fboundp 'member)
  184. ;;            ;; avoid using someone else's possibly bogus definition of this.
  185. ;;            (subrp (symbol-function 'member)))
  186. ;;       (defun member (elt list)
  187. ;;         "like memq, but uses equal instead of eq.  In v19, this is a subr."
  188. ;;         (while (and list (not (equal elt (car list))))
  189. ;;           (setq list (cdr list)))
  190. ;;         list))))
  191.  
  192.  
  193. (defvar emacs-lisp-file-regexp (if (eq system-type 'vax-vms)
  194.                    "\\.EL\\(;[0-9]+\\)?$"
  195.                  "\\.el$")
  196.   "*Regexp which matches Emacs Lisp source files.
  197. You may want to redefine `byte-compile-dest-file' if you change this.")
  198.  
  199. ;; This enables file name handlers such as jka-compr
  200. ;; to remove parts of the file name that should not be copied
  201. ;; through to the output file name.
  202. (defun byte-compiler-base-file-name (filename)
  203.   (let ((handler (find-file-name-handler filename
  204.                      'byte-compiler-base-file-name)))
  205.     (if handler
  206.     (funcall handler 'byte-compiler-base-file-name filename)
  207.       filename)))
  208.  
  209. (or (fboundp 'byte-compile-dest-file)
  210.     ;; The user may want to redefine this along with emacs-lisp-file-regexp,
  211.     ;; so only define it if it is undefined.
  212.     (defun byte-compile-dest-file (filename)
  213.       "Convert an Emacs Lisp source file name to a compiled file name."
  214.       (setq filename (byte-compiler-base-file-name filename))
  215.       (setq filename (file-name-sans-versions filename))
  216.       (cond ((eq system-type 'vax-vms)
  217.          (concat (substring filename 0 (string-match ";" filename)) "c"))
  218.         ((string-match emacs-lisp-file-regexp filename)
  219.          (concat (substring filename 0 (match-beginning 0)) ".elc"))
  220.         (t (concat filename ".elc")))))
  221.  
  222. ;; This can be the 'byte-compile property of any symbol.
  223. (autoload 'byte-compile-inline-expand "byte-opt")
  224.  
  225. ;; This is the entrypoint to the lapcode optimizer pass1.
  226. (autoload 'byte-optimize-form "byte-opt")
  227. ;; This is the entrypoint to the lapcode optimizer pass2.
  228. (autoload 'byte-optimize-lapcode "byte-opt")
  229. (autoload 'byte-compile-unfold-lambda "byte-opt")
  230.  
  231. ;; This is the entry point to the decompiler, which is used by the
  232. ;; disassembler.  The disassembler just requires 'byte-compile, but
  233. ;; that doesn't define this function, so this seems to be a reasonable
  234. ;; thing to do.
  235. (autoload 'byte-decompile-bytecode "byte-opt")
  236.  
  237. (defvar byte-compile-verbose
  238.   (and (not noninteractive) (> baud-rate search-slow-speed))
  239.   "*Non-nil means print messages describing progress of byte-compiler.")
  240.  
  241. (defvar byte-compile-compatibility nil
  242.   "*Non-nil means generate output that can run in Emacs 18.")
  243.  
  244. ;; (defvar byte-compile-generate-emacs19-bytecodes
  245. ;;         (not (or (and (boundp 'epoch::version) epoch::version)
  246. ;;          (string-lessp emacs-version "19")))
  247. ;;   "*If this is true, then the byte-compiler will generate bytecode which 
  248. ;; makes use of byte-ops which are present only in Emacs 19.  Code generated
  249. ;; this way can never be run in Emacs 18, and may even cause it to crash.")
  250.  
  251. (defvar byte-optimize t
  252.   "*Enables optimization in the byte compiler.
  253. nil means don't do any optimization.
  254. t means do all optimizations.
  255. `source' means do source-level optimizations only.
  256. `byte' means do code-level optimizations only.")
  257.  
  258. (defvar byte-compile-delete-errors t
  259.   "*If non-nil, the optimizer may delete forms that may signal an error.
  260. This includes variable references and calls to functions such as `car'.")
  261.  
  262. (defvar byte-compile-dynamic nil
  263.   "*If non-nil, compile function bodies so they load lazily.
  264. They are hidden comments in the compiled file, and brought into core when the
  265. function is called.
  266.  
  267. To enable this option, make it a file-local variable
  268. in the source file you want it to apply to.
  269. For example, add  -*-byte-compile-dynamic: t;-*- on the first line.
  270.  
  271. When this option is true, if you load the compiled file and then move it,
  272. the functions you loaded will not be able to run.")
  273.  
  274. (defvar byte-compile-dynamic-docstrings t
  275.   "*If non-nil, compile doc strings for lazy access.
  276. We bury the doc strings of functions and variables
  277. inside comments in the file, and bring them into core only when they
  278. are actually needed.
  279.  
  280. When this option is true, if you load the compiled file and then move it,
  281. you won't be able to find the documentation of anything in that file.
  282.  
  283. To disable this option for a certain file, make it a file-local variable
  284. in the source file.  For example, add this to the first line:
  285.   -*-byte-compile-dynamic-docstrings:nil;-*-
  286. You can also set the variable globally.
  287.  
  288. This option is enabled by default because it reduces Emacs memory usage.")
  289.  
  290. (defvar byte-optimize-log nil
  291.   "*If true, the byte-compiler will log its optimizations into *Compile-Log*.
  292. If this is 'source, then only source-level optimizations will be logged.
  293. If it is 'byte, then only byte-level optimizations will be logged.")
  294.  
  295. (defvar byte-compile-error-on-warn nil
  296.   "*If true, the byte-compiler reports warnings with `error'.")
  297.  
  298. (defconst byte-compile-warning-types
  299.   '(redefine callargs free-vars unresolved obsolete))
  300. (defvar byte-compile-warnings t
  301.   "*List of warnings that the byte-compiler should issue (t for all).
  302. Elements of the list may be be:
  303.  
  304.   free-vars   references to variables not in the current lexical scope.
  305.   unresolved  calls to unknown functions.
  306.   callargs    lambda calls with args that don't match the definition.
  307.   redefine    function cell redefined from a macro to a lambda or vice
  308.               versa, or redefined to take a different number of arguments.
  309.   obsolete      obsolete variables and functions.
  310.  
  311. See also the macro `byte-compiler-options'.")
  312.  
  313. (defvar byte-compile-generate-call-tree nil
  314.   "*Non-nil means collect call-graph information when compiling.
  315. This records functions were called and from where.
  316. If the value is t, compilation displays the call graph when it finishes.
  317. If the value is neither t nor nil, compilation asks you whether to display
  318. the graph.
  319.  
  320. The call tree only lists functions called, not macros used. Those functions
  321. which the byte-code interpreter knows about directly (eq, cons, etc.) are
  322. not reported.
  323.  
  324. The call tree also lists those functions which are not known to be called
  325. \(that is, to which no calls have been compiled).  Functions which can be
  326. invoked interactively are excluded from this list.")
  327.  
  328. (defconst byte-compile-call-tree nil "Alist of functions and their call tree.
  329. Each element looks like
  330.  
  331.   \(FUNCTION CALLERS CALLS\)
  332.  
  333. where CALLERS is a list of functions that call FUNCTION, and CALLS
  334. is a list of functions for which calls were generated while compiling
  335. FUNCTION.")
  336.  
  337. (defvar byte-compile-call-tree-sort 'name
  338.   "*If non-nil, sort the call tree.
  339. The values `name', `callers', `calls', `calls+callers'
  340. specify different fields to sort on.")
  341.  
  342. ;; (defvar byte-compile-overwrite-file t
  343. ;;   "If nil, old .elc files are deleted before the new is saved, and .elc
  344. ;; files will have the same modes as the corresponding .el file.  Otherwise,
  345. ;; existing .elc files will simply be overwritten, and the existing modes
  346. ;; will not be changed.  If this variable is nil, then an .elc file which 
  347. ;; is a symbolic link will be turned into a normal file, instead of the file
  348. ;; which the link points to being overwritten.")
  349.  
  350. (defvar byte-compile-constants nil
  351.   "list of all constants encountered during compilation of this form")
  352. (defvar byte-compile-variables nil
  353.   "list of all variables encountered during compilation of this form")
  354. (defvar byte-compile-bound-variables nil
  355.   "list of variables bound in the context of the current form; this list
  356. lives partly on the stack.")
  357. (defvar byte-compile-free-references)
  358. (defvar byte-compile-free-assignments)
  359.  
  360. (defvar byte-compiler-error-flag)
  361.  
  362. (defconst byte-compile-initial-macro-environment
  363.   '(
  364. ;;     (byte-compiler-options . (lambda (&rest forms)
  365. ;;                    (apply 'byte-compiler-options-handler forms)))
  366.     (eval-when-compile . (lambda (&rest body)
  367.                (list 'quote (eval (byte-compile-top-level
  368.                            (cons 'progn body))))))
  369.     (eval-and-compile . (lambda (&rest body)
  370.               (eval (cons 'progn body))
  371.               (cons 'progn body))))
  372.   "The default macro-environment passed to macroexpand by the compiler.
  373. Placing a macro here will cause a macro to have different semantics when
  374. expanded by the compiler as when expanded by the interpreter.")
  375.  
  376. (defvar byte-compile-macro-environment byte-compile-initial-macro-environment
  377.   "Alist of macros defined in the file being compiled.
  378. Each element looks like (MACRONAME . DEFINITION).  It is
  379. \(MACRONAME . nil) when a macro is redefined as a function.")
  380.  
  381. (defvar byte-compile-function-environment nil
  382.   "Alist of functions defined in the file being compiled.
  383. This is so we can inline them when necessary.
  384. Each element looks like (FUNCTIONNAME . DEFINITION).  It is
  385. \(FUNCTIONNAME . nil) when a function is redefined as a macro.")
  386.  
  387. (defvar byte-compile-unresolved-functions nil
  388.   "Alist of undefined functions to which calls have been compiled (used for
  389. warnings when the function is later defined with incorrect args).")
  390.  
  391. (defvar byte-compile-tag-number 0)
  392. (defvar byte-compile-output nil
  393.   "Alist describing contents to put in byte code string.
  394. Each element is (INDEX . VALUE)")
  395. (defvar byte-compile-depth 0 "Current depth of execution stack.")
  396. (defvar byte-compile-maxdepth 0 "Maximum depth of execution stack.")
  397.  
  398.  
  399. ;;; The byte codes; this information is duplicated in bytecomp.c
  400.  
  401. (defconst byte-code-vector nil
  402.   "An array containing byte-code names indexed by byte-code values.")
  403.  
  404. (defconst byte-stack+-info nil
  405.   "An array with the stack adjustment for each byte-code.")
  406.  
  407. (defmacro byte-defop (opcode stack-adjust opname &optional docstring)
  408.   ;; This is a speed-hack for building the byte-code-vector at compile-time.
  409.   ;; We fill in the vector at macroexpand-time, and then after the last call
  410.   ;; to byte-defop, we write the vector out as a constant instead of writing
  411.   ;; out a bunch of calls to aset.
  412.   ;; Actually, we don't fill in the vector itself, because that could make
  413.   ;; it problematic to compile big changes to this compiler; we store the
  414.   ;; values on its plist, and remove them later in -extrude.
  415.   (let ((v1 (or (get 'byte-code-vector 'tmp-compile-time-value)
  416.         (put 'byte-code-vector 'tmp-compile-time-value
  417.              (make-vector 256 nil))))
  418.     (v2 (or (get 'byte-stack+-info 'tmp-compile-time-value)
  419.         (put 'byte-stack+-info 'tmp-compile-time-value
  420.              (make-vector 256 nil)))))
  421.     (aset v1 opcode opname)
  422.     (aset v2 opcode stack-adjust))
  423.   (if docstring
  424.       (list 'defconst opname opcode (concat "Byte code opcode " docstring "."))
  425.       (list 'defconst opname opcode)))
  426.  
  427. (defmacro byte-extrude-byte-code-vectors ()
  428.   (prog1 (list 'setq 'byte-code-vector
  429.              (get 'byte-code-vector 'tmp-compile-time-value)
  430.              'byte-stack+-info
  431.              (get 'byte-stack+-info 'tmp-compile-time-value))
  432.     ;; emacs-18 has no REMPROP.
  433.     (put 'byte-code-vector 'tmp-compile-time-value nil)
  434.     (put 'byte-stack+-info 'tmp-compile-time-value nil)))
  435.  
  436.  
  437. ;; unused: 0-7
  438.  
  439. ;; These opcodes are special in that they pack their argument into the
  440. ;; opcode word.
  441. ;;
  442. (byte-defop   8  1 byte-varref    "for variable reference")
  443. (byte-defop  16 -1 byte-varset    "for setting a variable")
  444. (byte-defop  24 -1 byte-varbind    "for binding a variable")
  445. (byte-defop  32  0 byte-call    "for calling a function")
  446. (byte-defop  40  0 byte-unbind    "for unbinding special bindings")
  447. ;; codes 8-47 are consumed by the preceding opcodes
  448.  
  449. ;; unused: 48-55
  450.  
  451. (byte-defop  56 -1 byte-nth)
  452. (byte-defop  57  0 byte-symbolp)
  453. (byte-defop  58  0 byte-consp)
  454. (byte-defop  59  0 byte-stringp)
  455. (byte-defop  60  0 byte-listp)
  456. (byte-defop  61 -1 byte-eq)
  457. (byte-defop  62 -1 byte-memq)
  458. (byte-defop  63  0 byte-not)
  459. (byte-defop  64  0 byte-car)
  460. (byte-defop  65  0 byte-cdr)
  461. (byte-defop  66 -1 byte-cons)
  462. (byte-defop  67  0 byte-list1)
  463. (byte-defop  68 -1 byte-list2)
  464. (byte-defop  69 -2 byte-list3)
  465. (byte-defop  70 -3 byte-list4)
  466. (byte-defop  71  0 byte-length)
  467. (byte-defop  72 -1 byte-aref)
  468. (byte-defop  73 -2 byte-aset)
  469. (byte-defop  74  0 byte-symbol-value)
  470. (byte-defop  75  0 byte-symbol-function) ; this was commented out
  471. (byte-defop  76 -1 byte-set)
  472. (byte-defop  77 -1 byte-fset) ; this was commented out
  473. (byte-defop  78 -1 byte-get)
  474. (byte-defop  79 -2 byte-substring)
  475. (byte-defop  80 -1 byte-concat2)
  476. (byte-defop  81 -2 byte-concat3)
  477. (byte-defop  82 -3 byte-concat4)
  478. (byte-defop  83  0 byte-sub1)
  479. (byte-defop  84  0 byte-add1)
  480. (byte-defop  85 -1 byte-eqlsign)
  481. (byte-defop  86 -1 byte-gtr)
  482. (byte-defop  87 -1 byte-lss)
  483. (byte-defop  88 -1 byte-leq)
  484. (byte-defop  89 -1 byte-geq)
  485. (byte-defop  90 -1 byte-diff)
  486. (byte-defop  91  0 byte-negate)
  487. (byte-defop  92 -1 byte-plus)
  488. (byte-defop  93 -1 byte-max)
  489. (byte-defop  94 -1 byte-min)
  490. (byte-defop  95 -1 byte-mult) ; v19 only
  491. (byte-defop  96  1 byte-point)
  492. (byte-defop  97  1 byte-mark-OBSOLETE) ; no longer generated as of v18
  493. (byte-defop  98  0 byte-goto-char)
  494. (byte-defop  99  0 byte-insert)
  495. (byte-defop 100  1 byte-point-max)
  496. (byte-defop 101  1 byte-point-min)
  497. (byte-defop 102  0 byte-char-after)
  498. (byte-defop 103  1 byte-following-char)
  499. (byte-defop 104  1 byte-preceding-char)
  500. (byte-defop 105  1 byte-current-column)
  501. (byte-defop 106  0 byte-indent-to)
  502. (byte-defop 107  0 byte-scan-buffer-OBSOLETE) ; no longer generated as of v18
  503. (byte-defop 108  1 byte-eolp)
  504. (byte-defop 109  1 byte-eobp)
  505. (byte-defop 110  1 byte-bolp)
  506. (byte-defop 111  1 byte-bobp)
  507. (byte-defop 112  1 byte-current-buffer)
  508. (byte-defop 113  0 byte-set-buffer)
  509. (byte-defop 114  1 byte-read-char-OBSOLETE)
  510. (byte-defop 115  0 byte-set-mark-OBSOLETE)
  511. (byte-defop 116  1 byte-interactive-p)
  512.  
  513. ;; These ops are new to v19
  514. (byte-defop 117  0 byte-forward-char)
  515. (byte-defop 118  0 byte-forward-word)
  516. (byte-defop 119 -1 byte-skip-chars-forward)
  517. (byte-defop 120 -1 byte-skip-chars-backward)
  518. (byte-defop 121  0 byte-forward-line)
  519. (byte-defop 122  0 byte-char-syntax)
  520. (byte-defop 123 -1 byte-buffer-substring)
  521. (byte-defop 124 -1 byte-delete-region)
  522. (byte-defop 125 -1 byte-narrow-to-region)
  523. (byte-defop 126  1 byte-widen)
  524. (byte-defop 127  0 byte-end-of-line)
  525.  
  526. ;; unused: 128
  527.  
  528. ;; These store their argument in the next two bytes
  529. (byte-defop 129  1 byte-constant2
  530.    "for reference to a constant with vector index >= byte-constant-limit")
  531. (byte-defop 130  0 byte-goto "for unconditional jump")
  532. (byte-defop 131 -1 byte-goto-if-nil "to pop value and jump if it's nil")
  533. (byte-defop 132 -1 byte-goto-if-not-nil "to pop value and jump if it's not nil")
  534. (byte-defop 133 -1 byte-goto-if-nil-else-pop
  535.   "to examine top-of-stack, jump and don't pop it if it's nil, 
  536. otherwise pop it")
  537. (byte-defop 134 -1 byte-goto-if-not-nil-else-pop
  538.   "to examine top-of-stack, jump and don't pop it if it's non nil, 
  539. otherwise pop it")
  540.  
  541. (byte-defop 135 -1 byte-return "to pop a value and return it from `byte-code'")
  542. (byte-defop 136 -1 byte-discard "to discard one value from stack")
  543. (byte-defop 137  1 byte-dup     "to duplicate the top of the stack")
  544.  
  545. (byte-defop 138  0 byte-save-excursion
  546.   "to make a binding to record the buffer, point and mark")
  547. (byte-defop 139  0 byte-save-window-excursion
  548.   "to make a binding to record entire window configuration")
  549. (byte-defop 140  0 byte-save-restriction
  550.   "to make a binding to record the current buffer clipping restrictions")
  551. (byte-defop 141 -1 byte-catch
  552.   "for catch.  Takes, on stack, the tag and an expression for the body")
  553. (byte-defop 142 -1 byte-unwind-protect
  554.   "for unwind-protect.  Takes, on stack, an expression for the unwind-action")
  555.  
  556. ;; For condition-case.  Takes, on stack, the variable to bind, 
  557. ;; an expression for the body, and a list of clauses.
  558. (byte-defop 143 -2 byte-condition-case)
  559.  
  560. ;; For entry to with-output-to-temp-buffer.
  561. ;; Takes, on stack, the buffer name.
  562. ;; Binds standard-output and does some other things.
  563. ;; Returns with temp buffer on the stack in place of buffer name.
  564. (byte-defop 144  0 byte-temp-output-buffer-setup)
  565.  
  566. ;; For exit from with-output-to-temp-buffer.
  567. ;; Expects the temp buffer on the stack underneath value to return.
  568. ;; Pops them both, then pushes the value back on.
  569. ;; Unbinds standard-output and makes the temp buffer visible.
  570. (byte-defop 145 -1 byte-temp-output-buffer-show)
  571.  
  572. ;; these ops are new to v19
  573.  
  574. ;; To unbind back to the beginning of this frame.
  575. ;; Not used yet, but will be needed for tail-recursion elimination.
  576. (byte-defop 146  0 byte-unbind-all)
  577.  
  578. ;; these ops are new to v19
  579. (byte-defop 147 -2 byte-set-marker)
  580. (byte-defop 148  0 byte-match-beginning)
  581. (byte-defop 149  0 byte-match-end)
  582. (byte-defop 150  0 byte-upcase)
  583. (byte-defop 151  0 byte-downcase)
  584. (byte-defop 152 -1 byte-string=)
  585. (byte-defop 153 -1 byte-string<)
  586. (byte-defop 154 -1 byte-equal)
  587. (byte-defop 155 -1 byte-nthcdr)
  588. (byte-defop 156 -1 byte-elt)
  589. (byte-defop 157 -1 byte-member)
  590. (byte-defop 158 -1 byte-assq)
  591. (byte-defop 159  0 byte-nreverse)
  592. (byte-defop 160 -1 byte-setcar)
  593. (byte-defop 161 -1 byte-setcdr)
  594. (byte-defop 162  0 byte-car-safe)
  595. (byte-defop 163  0 byte-cdr-safe)
  596. (byte-defop 164 -1 byte-nconc)
  597. (byte-defop 165 -1 byte-quo)
  598. (byte-defop 166 -1 byte-rem)
  599. (byte-defop 167  0 byte-numberp)
  600. (byte-defop 168  0 byte-integerp)
  601.  
  602. ;; unused: 169-174
  603. (byte-defop 175 nil byte-listN)
  604. (byte-defop 176 nil byte-concatN)
  605. (byte-defop 177 nil byte-insertN)
  606.  
  607. ;; unused: 178-191
  608.  
  609. (byte-defop 192  1 byte-constant    "for reference to a constant")
  610. ;; codes 193-255 are consumed by byte-constant.
  611. (defconst byte-constant-limit 64
  612.   "Exclusive maximum index usable in the `byte-constant' opcode.")
  613.  
  614. (defconst byte-goto-ops '(byte-goto byte-goto-if-nil byte-goto-if-not-nil
  615.               byte-goto-if-nil-else-pop
  616.               byte-goto-if-not-nil-else-pop)
  617.   "List of byte-codes whose offset is a pc.")
  618.  
  619. (defconst byte-goto-always-pop-ops '(byte-goto-if-nil byte-goto-if-not-nil))
  620.  
  621. (byte-extrude-byte-code-vectors)
  622.  
  623. ;;; lapcode generator
  624. ;;;
  625. ;;; the byte-compiler now does source -> lapcode -> bytecode instead of
  626. ;;; source -> bytecode, because it's a lot easier to make optimizations
  627. ;;; on lapcode than on bytecode.
  628. ;;;
  629. ;;; Elements of the lapcode list are of the form (<instruction> . <parameter>)
  630. ;;; where instruction is a symbol naming a byte-code instruction,
  631. ;;; and parameter is an argument to that instruction, if any.
  632. ;;;
  633. ;;; The instruction can be the pseudo-op TAG, which means that this position 
  634. ;;; in the instruction stream is a target of a goto.  (car PARAMETER) will be
  635. ;;; the PC for this location, and the whole instruction "(TAG pc)" will be the
  636. ;;; parameter for some goto op.
  637. ;;;
  638. ;;; If the operation is varbind, varref, varset or push-constant, then the
  639. ;;; parameter is (variable/constant . index_in_constant_vector).
  640. ;;;
  641. ;;; First, the source code is macroexpanded and optimized in various ways.
  642. ;;; Then the resultant code is compiled into lapcode.  Another set of
  643. ;;; optimizations are then run over the lapcode.  Then the variables and
  644. ;;; constants referenced by the lapcode are collected and placed in the
  645. ;;; constants-vector.  (This happens now so that variables referenced by dead
  646. ;;; code don't consume space.)  And finally, the lapcode is transformed into
  647. ;;; compacted byte-code.
  648. ;;;
  649. ;;; A distinction is made between variables and constants because the variable-
  650. ;;; referencing instructions are more sensitive to the variables being near the
  651. ;;; front of the constants-vector than the constant-referencing instructions.
  652. ;;; Also, this lets us notice references to free variables.
  653.  
  654. (defun byte-compile-lapcode (lap)
  655.   "Turns lapcode into bytecode.  The lapcode is destroyed."
  656.   ;; Lapcode modifications: changes the ID of a tag to be the tag's PC.
  657.   (let ((pc 0)            ; Program counter
  658.     op off            ; Operation & offset
  659.     (bytes '())        ; Put the output bytes here
  660.     (patchlist nil)        ; List of tags and goto's to patch
  661.     rest rel tmp)
  662.     (while lap
  663.       (setq op (car (car lap))
  664.         off (cdr (car lap)))
  665.       (cond ((not (symbolp op))
  666.          (error "Non-symbolic opcode `%s'" op))
  667.         ((eq op 'TAG)
  668.          (setcar off pc)
  669.          (setq patchlist (cons off patchlist)))
  670.         ((memq op byte-goto-ops)
  671.          (setq pc (+ pc 3))
  672.          (setq bytes (cons (cons pc (cdr off))
  673.                    (cons nil
  674.                      (cons (symbol-value op) bytes))))
  675.          (setq patchlist (cons bytes patchlist)))
  676.         (t
  677.          (setq bytes
  678.            (cond ((cond ((consp off)
  679.                  ;; Variable or constant reference
  680.                  (setq off (cdr off))
  681.                  (eq op 'byte-constant)))
  682.               (cond ((< off byte-constant-limit)
  683.                  (setq pc (1+ pc))
  684.                  (cons (+ byte-constant off) bytes))
  685.                 (t
  686.                  (setq pc (+ 3 pc))
  687.                  (cons (lsh off -8)
  688.                        (cons (logand off 255)
  689.                          (cons byte-constant2 bytes))))))
  690.              ((<= byte-listN (symbol-value op))
  691.               (setq pc (+ 2 pc))
  692.               (cons off (cons (symbol-value op) bytes)))
  693.              ((< off 6)
  694.               (setq pc (1+ pc))
  695.               (cons (+ (symbol-value op) off) bytes))
  696.              ((< off 256)
  697.               (setq pc (+ 2 pc))
  698.               (cons off (cons (+ (symbol-value op) 6) bytes)))
  699.              (t
  700.               (setq pc (+ 3 pc))
  701.               (cons (lsh off -8)
  702.                 (cons (logand off 255)
  703.                       (cons (+ (symbol-value op) 7)
  704.                         bytes))))))))
  705.       (setq lap (cdr lap)))
  706.     ;;(if (not (= pc (length bytes)))
  707.     ;;    (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
  708.     ;; Patch PC into jumps
  709.     (let (bytes)
  710.       (while patchlist
  711.     (setq bytes (car patchlist))
  712.     (cond ((atom (car bytes)))    ; Tag
  713.           (t            ; Absolute jump
  714.            (setq pc (car (cdr (car bytes))))    ; Pick PC from tag
  715.            (setcar (cdr bytes) (logand pc 255))
  716.            (setcar bytes (lsh pc -8))))
  717.     (setq patchlist (cdr patchlist))))
  718.     (concat (nreverse bytes))))
  719.  
  720.  
  721. ;;; byte compiler messages
  722.  
  723. (defvar byte-compile-current-form nil)
  724. (defvar byte-compile-current-file nil)
  725. (defvar byte-compile-dest-file nil)
  726.  
  727. (defmacro byte-compile-log (format-string &rest args)
  728.   (list 'and
  729.     'byte-optimize
  730.     '(memq byte-optimize-log '(t source))
  731.     (list 'let '((print-escape-newlines t)
  732.              (print-level 4)
  733.              (print-length 4))
  734.           (list 'byte-compile-log-1
  735.             (cons 'format
  736.               (cons format-string
  737.             (mapcar
  738.              '(lambda (x)
  739.                 (if (symbolp x) (list 'prin1-to-string x) x))
  740.              args)))))))
  741.  
  742. (defconst byte-compile-last-warned-form nil)
  743.  
  744. ;; Log a message STRING in *Compile-Log*.
  745. ;; Also log the current function and file if not already done.
  746. (defun byte-compile-log-1 (string &optional fill)
  747.   (cond (noninteractive
  748.      (if (or byte-compile-current-file
  749.          (and byte-compile-last-warned-form
  750.               (not (eq byte-compile-current-form
  751.                    byte-compile-last-warned-form))))
  752.          (message "While compiling %s%s:"
  753.               (or byte-compile-current-form "toplevel forms")
  754.               (if byte-compile-current-file
  755.               (if (stringp byte-compile-current-file)
  756.                   (concat " in file " byte-compile-current-file)
  757.                 (concat " in buffer "
  758.                     (buffer-name byte-compile-current-file)))
  759.             "")))
  760.      (message "  %s" string))
  761.     (t
  762.      (save-excursion
  763.        (set-buffer (get-buffer-create "*Compile-Log*"))
  764.        (goto-char (point-max))
  765.        (cond ((or byte-compile-current-file
  766.               (and byte-compile-last-warned-form
  767.                (not (eq byte-compile-current-form
  768.                     byte-compile-last-warned-form))))
  769.           (if byte-compile-current-file
  770.               (insert "\n\^L\n" (current-time-string) "\n"))
  771.           (insert "While compiling "
  772.               (if byte-compile-current-form
  773.                   (format "%s" byte-compile-current-form)
  774.                 "toplevel forms"))
  775.           (if byte-compile-current-file
  776.               (if (stringp byte-compile-current-file)
  777.               (insert " in file " byte-compile-current-file)
  778.             (insert " in buffer "
  779.                 (buffer-name byte-compile-current-file))))
  780.           (insert ":\n")))
  781.        (insert "  " string "\n")
  782.        (if (and fill (not (string-match "\n" string)))
  783.            (let ((fill-prefix "     ")
  784.              (fill-column 78))
  785.          (fill-paragraph nil)))
  786.        )))
  787.   (setq byte-compile-current-file nil
  788.     byte-compile-last-warned-form byte-compile-current-form))
  789.  
  790. ;; Log the start of a file in *Compile-Log*, and mark it as done.
  791. ;; But do nothing in batch mode.
  792. (defun byte-compile-log-file ()
  793.   (and byte-compile-current-file (not noninteractive)
  794.        (save-excursion
  795.      (set-buffer (get-buffer-create "*Compile-Log*"))
  796.      (goto-char (point-max))
  797.      (insert "\n\^L\nCompiling "
  798.          (if (stringp byte-compile-current-file)
  799.              (concat "file " byte-compile-current-file)
  800.            (concat "buffer " (buffer-name byte-compile-current-file)))
  801.          " at " (current-time-string) "\n")
  802.      (setq byte-compile-current-file nil))))
  803.  
  804. (defun byte-compile-warn (format &rest args)
  805.   (setq format (apply 'format format args))
  806.   (if byte-compile-error-on-warn
  807.       (error "%s" format)        ; byte-compile-file catches and logs it
  808.     (byte-compile-log-1 (concat "** " format) t)
  809. ;;; It is useless to flash warnings too fast to be read.
  810. ;;; Besides, they will all be shown at the end.
  811. ;;;    (or noninteractive  ; already written on stdout.
  812. ;;;    (message "Warning: %s" format))
  813.     ))
  814.  
  815. ;;; This function should be used to report errors that have halted
  816. ;;; compilation of the current file.
  817. (defun byte-compile-report-error (error-info)
  818.   (setq byte-compiler-error-flag t)
  819.   (byte-compile-log-1
  820.    (concat "!! "
  821.        (format (if (cdr error-info) "%s (%s)" "%s")
  822.            (get (car error-info) 'error-message)
  823.            (prin1-to-string (cdr error-info))))))
  824.  
  825. ;;; Used by make-obsolete.
  826. (defun byte-compile-obsolete (form)
  827.   (let ((new (get (car form) 'byte-obsolete-info)))
  828.     (if (memq 'obsolete byte-compile-warnings)
  829.     (byte-compile-warn "%s is an obsolete function; %s" (car form)
  830.                (if (stringp (car new))
  831.                    (car new)
  832.                    (format "use %s instead." (car new)))))
  833.     (funcall (or (cdr new) 'byte-compile-normal-call) form)))
  834.  
  835. ;; Compiler options
  836.  
  837. ;; (defvar byte-compiler-valid-options
  838. ;;   '((optimize byte-optimize (t nil source byte) val)
  839. ;;     (file-format byte-compile-compatibility (emacs18 emacs19)
  840. ;;          (eq val 'emacs18))
  841. ;; ;;     (new-bytecodes byte-compile-generate-emacs19-bytecodes (t nil) val)
  842. ;;     (delete-errors byte-compile-delete-errors (t nil) val)
  843. ;;     (verbose byte-compile-verbose (t nil) val)
  844. ;;     (warnings byte-compile-warnings ((callargs redefine free-vars unresolved))
  845. ;;           val)))
  846.  
  847. ;; Inhibit v18/v19 selectors if the version is hardcoded.
  848. ;; #### This should print a warning if the user tries to change something 
  849. ;; than can't be changed because the running compiler doesn't support it.
  850. ;; (cond
  851. ;;  ((byte-compile-single-version)
  852. ;;   (setcar (cdr (cdr (assq 'new-bytecodes byte-compiler-valid-options)))
  853. ;;       (list (byte-compile-version-cond
  854. ;;          byte-compile-generate-emacs19-bytecodes)))
  855. ;;   (setcar (cdr (cdr (assq 'file-format byte-compiler-valid-options)))
  856. ;;       (if (byte-compile-version-cond byte-compile-compatibility)
  857. ;;           '(emacs18) '(emacs19)))))
  858.  
  859. ;; (defun byte-compiler-options-handler (&rest args)
  860. ;;   (let (key val desc choices)
  861. ;;     (while args
  862. ;;       (if (or (atom (car args)) (nthcdr 2 (car args)) (null (cdr (car args))))
  863. ;;       (error "Malformed byte-compiler option `%s'" (car args)))
  864. ;;       (setq key (car (car args))
  865. ;;         val (car (cdr (car args)))
  866. ;;         desc (assq key byte-compiler-valid-options))
  867. ;;       (or desc
  868. ;;       (error "Unknown byte-compiler option `%s'" key))
  869. ;;       (setq choices (nth 2 desc))
  870. ;;       (if (consp (car choices))
  871. ;;       (let (this
  872. ;;         (handler 'cons)
  873. ;;         (ret (and (memq (car val) '(+ -))
  874. ;;               (copy-sequence (if (eq t (symbol-value (nth 1 desc)))
  875. ;;                          choices
  876. ;;                        (symbol-value (nth 1 desc)))))))
  877. ;;         (setq choices (car  choices))
  878. ;;         (while val
  879. ;;           (setq this (car val))
  880. ;;           (cond ((memq this choices)
  881. ;;              (setq ret (funcall handler this ret)))
  882. ;;             ((eq this '+) (setq handler 'cons))
  883. ;;             ((eq this '-) (setq handler 'delq))
  884. ;;             ((error "`%s' only accepts %s" key choices)))
  885. ;;           (setq val (cdr val)))
  886. ;;         (set (nth 1 desc) ret))
  887. ;;     (or (memq val choices)
  888. ;;         (error "`%s' must be one of `%s'" key choices))
  889. ;;     (set (nth 1 desc) (eval (nth 3 desc))))
  890. ;;       (setq args (cdr args)))
  891. ;;     nil))
  892.  
  893. ;;; sanity-checking arglists
  894.  
  895. (defun byte-compile-fdefinition (name macro-p)
  896.   (let* ((list (if macro-p
  897.            byte-compile-macro-environment
  898.          byte-compile-function-environment))
  899.      (env (cdr (assq name list))))
  900.     (or env
  901.     (let ((fn name))
  902.       (while (and (symbolp fn)
  903.               (fboundp fn)
  904.               (or (symbolp (symbol-function fn))
  905.               (consp (symbol-function fn))
  906.               (and (not macro-p)
  907.                    (byte-code-function-p (symbol-function fn)))))
  908.         (setq fn (symbol-function fn)))
  909.       (if (and (not macro-p) (byte-code-function-p fn))
  910.           fn
  911.         (and (consp fn)
  912.          (if (eq 'macro (car fn))
  913.              (cdr fn)
  914.            (if macro-p
  915.                nil
  916.              (if (eq 'autoload (car fn))
  917.              nil
  918.                fn)))))))))
  919.  
  920. (defun byte-compile-arglist-signature (arglist)
  921.   (let ((args 0)
  922.     opts
  923.     restp)
  924.     (while arglist
  925.       (cond ((eq (car arglist) '&optional)
  926.          (or opts (setq opts 0)))
  927.         ((eq (car arglist) '&rest)
  928.          (if (cdr arglist)
  929.          (setq restp t
  930.                arglist nil)))
  931.         (t
  932.          (if opts
  933.          (setq opts (1+ opts))
  934.          (setq args (1+ args)))))
  935.       (setq arglist (cdr arglist)))
  936.     (cons args (if restp nil (if opts (+ args opts) args)))))
  937.  
  938.  
  939. (defun byte-compile-arglist-signatures-congruent-p (old new)
  940.   (not (or
  941.      (> (car new) (car old))  ; requires more args now
  942.      (and (null (cdr old))    ; took rest-args, doesn't any more
  943.           (cdr new))
  944.      (and (cdr new) (cdr old) ; can't take as many args now
  945.           (< (cdr new) (cdr old)))
  946.      )))
  947.  
  948. (defun byte-compile-arglist-signature-string (signature)
  949.   (cond ((null (cdr signature))
  950.      (format "%d+" (car signature)))
  951.     ((= (car signature) (cdr signature))
  952.      (format "%d" (car signature)))
  953.     (t (format "%d-%d" (car signature) (cdr signature)))))
  954.  
  955.  
  956. ;; Warn if the form is calling a function with the wrong number of arguments.
  957. (defun byte-compile-callargs-warn (form)
  958.   (let* ((def (or (byte-compile-fdefinition (car form) nil)
  959.           (byte-compile-fdefinition (car form) t)))
  960.      (sig (and def (byte-compile-arglist-signature
  961.              (if (eq 'lambda (car-safe def))
  962.                  (nth 1 def)
  963.                (if (byte-code-function-p def)
  964.                    (aref def 0)
  965.                  '(&rest def))))))
  966.      (ncall (length (cdr form))))
  967.     (if sig
  968.     (if (or (< ncall (car sig))
  969.         (and (cdr sig) (> ncall (cdr sig))))
  970.         (byte-compile-warn
  971.           "%s called with %d argument%s, but %s %s"
  972.           (car form) ncall
  973.           (if (= 1 ncall) "" "s")
  974.           (if (< ncall (car sig))
  975.           "requires"
  976.           "accepts only")
  977.           (byte-compile-arglist-signature-string sig)))
  978.       (or (fboundp (car form)) ; might be a subr or autoload.
  979.       (eq (car form) byte-compile-current-form) ; ## this doesn't work with recursion.
  980.       ;; It's a currently-undefined function.  Remember number of args in call.
  981.       (let ((cons (assq (car form) byte-compile-unresolved-functions))
  982.         (n (length (cdr form))))
  983.         (if cons
  984.         (or (memq n (cdr cons))
  985.             (setcdr cons (cons n (cdr cons))))
  986.         (setq byte-compile-unresolved-functions
  987.               (cons (list (car form) n)
  988.                 byte-compile-unresolved-functions))))))))
  989.  
  990. ;; Warn if the function or macro is being redefined with a different
  991. ;; number of arguments.
  992. (defun byte-compile-arglist-warn (form macrop)
  993.   (let ((old (byte-compile-fdefinition (nth 1 form) macrop)))
  994.     (if old
  995.     (let ((sig1 (byte-compile-arglist-signature
  996.               (if (eq 'lambda (car-safe old))
  997.               (nth 1 old)
  998.             (if (byte-code-function-p old)
  999.                 (aref old 0)
  1000.               '(&rest def)))))
  1001.           (sig2 (byte-compile-arglist-signature (nth 2 form))))
  1002.       (or (byte-compile-arglist-signatures-congruent-p sig1 sig2)
  1003.           (byte-compile-warn "%s %s used to take %s %s, now takes %s"
  1004.         (if (eq (car form) 'defun) "function" "macro")
  1005.         (nth 1 form)
  1006.         (byte-compile-arglist-signature-string sig1)
  1007.         (if (equal sig1 '(1 . 1)) "argument" "arguments")
  1008.         (byte-compile-arglist-signature-string sig2))))
  1009.       ;; This is the first definition.  See if previous calls are compatible.
  1010.       (let ((calls (assq (nth 1 form) byte-compile-unresolved-functions))
  1011.         nums sig min max)
  1012.     (if calls
  1013.         (progn
  1014.           (setq sig (byte-compile-arglist-signature (nth 2 form))
  1015.             nums (sort (copy-sequence (cdr calls)) (function <))
  1016.             min (car nums)
  1017.             max (car (nreverse nums)))
  1018.           (if (or (< min (car sig))
  1019.               (and (cdr sig) (> max (cdr sig))))
  1020.           (byte-compile-warn
  1021.         "%s being defined to take %s%s, but was previously called with %s"
  1022.                 (nth 1 form)
  1023.             (byte-compile-arglist-signature-string sig)
  1024.             (if (equal sig '(1 . 1)) " arg" " args")
  1025.             (byte-compile-arglist-signature-string (cons min max))))
  1026.           
  1027.           (setq byte-compile-unresolved-functions
  1028.             (delq calls byte-compile-unresolved-functions)))))
  1029.       )))
  1030.  
  1031. ;; If we have compiled any calls to functions which are not known to be 
  1032. ;; defined, issue a warning enumerating them.
  1033. ;; `unresolved' in the list `byte-compile-warnings' disables this.
  1034. (defun byte-compile-warn-about-unresolved-functions ()
  1035.   (if (memq 'unresolved byte-compile-warnings)
  1036.    (let ((byte-compile-current-form "the end of the data"))
  1037.     (if (cdr byte-compile-unresolved-functions)
  1038.     (let* ((str "The following functions are not known to be defined: ")
  1039.            (L (length str))
  1040.            (rest (reverse byte-compile-unresolved-functions))
  1041.            s)
  1042.       (while rest
  1043.         (setq s (symbol-name (car (car rest)))
  1044.           L (+ L (length s) 2)
  1045.           rest (cdr rest))
  1046.         (if (< L (1- fill-column))
  1047.         (setq str (concat str " " s (and rest ",")))
  1048.           (setq str (concat str "\n    " s (and rest ","))
  1049.             L (+ (length s) 4))))
  1050.       (byte-compile-warn "%s" str))
  1051.     (if byte-compile-unresolved-functions
  1052.         (byte-compile-warn "the function %s is not known to be defined."
  1053.           (car (car byte-compile-unresolved-functions)))))))
  1054.   nil)
  1055.  
  1056.  
  1057. (defmacro byte-compile-constp (form)
  1058.   ;; Returns non-nil if FORM is a constant.
  1059.   (` (cond ((consp (, form)) (eq (car (, form)) 'quote))
  1060.        ((not (symbolp (, form))))
  1061.        ((memq (, form) '(nil t))))))
  1062.  
  1063. (defmacro byte-compile-close-variables (&rest body)
  1064.   (cons 'let
  1065.     (cons '(;;
  1066.         ;; Close over these variables to encapsulate the
  1067.         ;; compilation state
  1068.         ;;
  1069.         (byte-compile-macro-environment
  1070.          ;; Copy it because the compiler may patch into the
  1071.          ;; macroenvironment.
  1072.          (copy-alist byte-compile-initial-macro-environment))
  1073.         (byte-compile-function-environment nil)
  1074.         (byte-compile-bound-variables nil)
  1075.         (byte-compile-free-references nil)
  1076.         (byte-compile-free-assignments nil)
  1077.         ;;
  1078.         ;; Close over these variables so that `byte-compiler-options'
  1079.         ;; can change them on a per-file basis.
  1080.         ;;
  1081.         (byte-compile-verbose byte-compile-verbose)
  1082.         (byte-optimize byte-optimize)
  1083.         (byte-compile-compatibility byte-compile-compatibility)
  1084.         (byte-compile-dynamic byte-compile-dynamic)
  1085.         (byte-compile-dynamic-docstrings
  1086.          byte-compile-dynamic-docstrings)
  1087. ;;         (byte-compile-generate-emacs19-bytecodes
  1088. ;;          byte-compile-generate-emacs19-bytecodes)
  1089.         (byte-compile-warnings (if (eq byte-compile-warnings t)
  1090.                        byte-compile-warning-types
  1091.                      byte-compile-warnings))
  1092.         )
  1093.           body)))
  1094.  
  1095. (defvar byte-compile-warnings-point-max nil)
  1096. (defmacro displaying-byte-compile-warnings (&rest body)
  1097.   (list 'let
  1098.     '((byte-compile-warnings-point-max byte-compile-warnings-point-max))
  1099.      ;; Log the file name.
  1100.      '(byte-compile-log-file)
  1101.      ;; Record how much is logged now.
  1102.      ;; We will display the log buffer if anything more is logged
  1103.      ;; before the end of BODY.
  1104.      '(or byte-compile-warnings-point-max
  1105.       (save-excursion
  1106.         (set-buffer (get-buffer-create "*Compile-Log*"))
  1107.         (setq byte-compile-warnings-point-max (point-max))))
  1108.      (list 'unwind-protect
  1109.        (list 'condition-case 'error-info
  1110.          (cons 'progn body)
  1111.            '(error
  1112.          (byte-compile-report-error error-info)))
  1113.        '(save-excursion
  1114.       ;; If there were compilation warnings, display them.
  1115.       (set-buffer "*Compile-Log*")
  1116.       (if (= byte-compile-warnings-point-max (point-max))
  1117.           nil
  1118.         (select-window
  1119.          (prog1 (selected-window)
  1120.            (select-window (display-buffer (current-buffer)))
  1121.            (goto-char byte-compile-warnings-point-max)
  1122.            (recenter 1))))))))
  1123.  
  1124.  
  1125. ;;;###autoload
  1126. (defun byte-force-recompile (directory)
  1127.   "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
  1128. Files in subdirectories of DIRECTORY are processed also."
  1129.   (interactive "DByte force recompile (directory): ")
  1130.   (byte-recompile-directory directory nil t))
  1131.  
  1132. ;;;###autoload
  1133. (defun byte-recompile-directory (directory &optional arg force)
  1134.   "Recompile every `.el' file in DIRECTORY that needs recompilation.
  1135. This is if a `.elc' file exists but is older than the `.el' file.
  1136. Files in subdirectories of DIRECTORY are processed also.
  1137.  
  1138. If the `.elc' file does not exist, normally the `.el' file is *not* compiled.
  1139. But a prefix argument (optional second arg) means ask user,
  1140. for each such `.el' file, whether to compile it.  Prefix argument 0 means
  1141. don't ask and compile the file anyway.
  1142.  
  1143. A nonzero prefix argument also means ask about each subdirectory.
  1144.  
  1145. If the third argument FORCE is non-nil,
  1146. recompile every `.el' file that already has a `.elc' file."
  1147.   (interactive "DByte recompile directory: \nP")
  1148.   (if arg
  1149.       (setq arg (prefix-numeric-value arg)))
  1150.   (if noninteractive
  1151.       nil
  1152.     (save-some-buffers)
  1153.     (force-mode-line-update))
  1154.   (let ((directories (list (expand-file-name directory)))
  1155.     (file-count 0)
  1156.     (dir-count 0)
  1157.     last-dir)
  1158.     (displaying-byte-compile-warnings
  1159.      (while directories
  1160.        (setq directory (car directories))
  1161.        (or noninteractive (message "Checking %s..." directory))
  1162.        (let ((files (directory-files directory))
  1163.          source dest)
  1164.      (while files
  1165.        (setq source (expand-file-name (car files) directory))
  1166.        (if (and (not (member (car files) '("." ".." "RCS" "CVS")))
  1167.             (file-directory-p source)
  1168.             (not (file-symlink-p source)))
  1169.            ;; This file is a subdirectory.  Handle them differently.
  1170.            (if (or (null arg)
  1171.                (eq 0 arg)
  1172.                (y-or-n-p (concat "Check " source "? ")))
  1173.            (setq directories
  1174.              (nconc directories (list source))))
  1175.          ;; It is an ordinary file.  Decide whether to compile it.
  1176.          (if (and (string-match emacs-lisp-file-regexp source)
  1177.               (not (auto-save-file-name-p source))
  1178.               (setq dest (byte-compile-dest-file source))
  1179.               (if (file-exists-p dest)
  1180.               ;; File was already compiled.
  1181.               (or force (file-newer-than-file-p source dest))
  1182.             ;; No compiled file exists yet.
  1183.             (and arg
  1184.                  (or (eq 0 arg)
  1185.                  (y-or-n-p (concat "Compile " source "? "))))))
  1186.          (progn (if (and noninteractive (not byte-compile-verbose))
  1187.                 (message "Compiling %s..." source))
  1188.             (byte-compile-file source)
  1189.             (or noninteractive
  1190.                 (message "Checking %s..." directory))
  1191.             (setq file-count (1+ file-count))
  1192.             (if (not (eq last-dir directory))
  1193.                 (setq last-dir directory
  1194.                   dir-count (1+ dir-count)))
  1195.             )))
  1196.        (setq files (cdr files))))
  1197.        (setq directories (cdr directories))))
  1198.     (message "Done (Total of %d file%s compiled%s)"
  1199.          file-count (if (= file-count 1) "" "s")
  1200.          (if (> dir-count 1) (format " in %d directories" dir-count) ""))))
  1201.  
  1202. ;;;###autoload
  1203. (defun byte-compile-file (filename &optional load)
  1204.   "Compile a file of Lisp code named FILENAME into a file of byte code.
  1205. The output file's name is made by appending `c' to the end of FILENAME.
  1206. With prefix arg (noninteractively: 2nd arg), load the file after compiling."
  1207. ;;  (interactive "fByte compile file: \nP")
  1208.   (interactive
  1209.    (let ((file buffer-file-name)
  1210.      (file-name nil)
  1211.      (file-dir nil))
  1212.      (and file
  1213.       (eq (cdr (assq 'major-mode (buffer-local-variables)))
  1214.           'emacs-lisp-mode)
  1215.       (setq file-name (file-name-nondirectory file)
  1216.         file-dir (file-name-directory file)))
  1217.      (list (read-file-name (if current-prefix-arg
  1218.                    "Byte compile and load file: "
  1219.                  "Byte compile file: ")
  1220.                file-dir file-name nil)
  1221.        current-prefix-arg)))
  1222.   ;; Expand now so we get the current buffer's defaults
  1223.   (setq filename (expand-file-name filename))
  1224.  
  1225.   ;; If we're compiling a file that's in a buffer and is modified, offer
  1226.   ;; to save it first.
  1227.   (or noninteractive
  1228.       (let ((b (get-file-buffer (expand-file-name filename))))
  1229.     (if (and b (buffer-modified-p b)
  1230.          (y-or-n-p (format "save buffer %s first? " (buffer-name b))))
  1231.         (save-excursion (set-buffer b) (save-buffer)))))
  1232.  
  1233.   (if byte-compile-verbose
  1234.       (message "Compiling %s..." filename))
  1235.   (let ((byte-compile-current-file filename)
  1236.     target-file input-buffer output-buffer
  1237.     byte-compile-dest-file)
  1238.     (setq target-file (byte-compile-dest-file filename))
  1239.     (setq byte-compile-dest-file target-file)
  1240.     (save-excursion
  1241.       (setq input-buffer (get-buffer-create " *Compiler Input*"))
  1242.       (set-buffer input-buffer)
  1243.       (erase-buffer)
  1244.       (insert-file-contents filename)
  1245.       ;; Run hooks including the uncompression hook.
  1246.       ;; If they change the file name, then change it for the output also.
  1247.       (let ((buffer-file-name filename)
  1248.         (default-major-mode 'emacs-lisp-mode)
  1249.         (enable-local-eval nil))
  1250.         (normal-mode)
  1251.         (setq filename buffer-file-name)))
  1252.     (setq byte-compiler-error-flag nil)
  1253.     ;; It is important that input-buffer not be current at this call,
  1254.     ;; so that the value of point set in input-buffer
  1255.     ;; within byte-compile-from-buffer lingers in that buffer.
  1256.     (setq output-buffer (byte-compile-from-buffer input-buffer filename))
  1257.     (if byte-compiler-error-flag
  1258.     nil
  1259.       (if byte-compile-verbose
  1260.       (message "Compiling %s...done" filename))
  1261.       (kill-buffer input-buffer)
  1262.       (save-excursion
  1263.     (set-buffer output-buffer)
  1264.     (goto-char (point-max))
  1265.     (insert "\n")            ; aaah, unix.
  1266.     (let ((vms-stmlf-recfm t))
  1267.       (if (file-writable-p target-file)
  1268.           (let ((kanji-flag nil))    ; for nemacs, from Nakagawa Takayuki
  1269.         (if (or (eq system-type 'ms-dos) (eq system-type 'windows-nt))
  1270.             (setq buffer-file-type t))
  1271.         (write-region 1 (point-max) target-file))
  1272.         ;; This is just to give a better error message than
  1273.         ;; write-region
  1274.         (signal 'file-error
  1275.             (list "Opening output file"
  1276.               (if (file-exists-p target-file)
  1277.                   "cannot overwrite file"
  1278.                 "directory not writable or nonexistent")
  1279.               target-file))))
  1280.     (kill-buffer (current-buffer)))
  1281.       (if (and byte-compile-generate-call-tree
  1282.            (or (eq t byte-compile-generate-call-tree)
  1283.            (y-or-n-p (format "Report call tree for %s? " filename))))
  1284.       (save-excursion
  1285.         (display-call-tree filename)))
  1286.       (if load
  1287.       (load target-file))
  1288.       t)))
  1289.  
  1290. ;;(defun byte-compile-and-load-file (&optional filename)
  1291. ;;  "Compile a file of Lisp code named FILENAME into a file of byte code,
  1292. ;;and then load it.  The output file's name is made by appending \"c\" to 
  1293. ;;the end of FILENAME."
  1294. ;;  (interactive)
  1295. ;;  (if filename ; I don't get it, (interactive-p) doesn't always work
  1296. ;;      (byte-compile-file filename t)
  1297. ;;    (let ((current-prefix-arg '(4)))
  1298. ;;      (call-interactively 'byte-compile-file))))
  1299.  
  1300. ;;(defun byte-compile-buffer (&optional buffer)
  1301. ;;  "Byte-compile and evaluate contents of BUFFER (default: the current buffer)."
  1302. ;;  (interactive "bByte compile buffer: ")
  1303. ;;  (setq buffer (if buffer (get-buffer buffer) (current-buffer)))
  1304. ;;  (message "Compiling %s..." (buffer-name buffer))
  1305. ;;  (let* ((filename (or (buffer-file-name buffer)
  1306. ;;               (concat "#<buffer " (buffer-name buffer) ">")))
  1307. ;;     (byte-compile-current-file buffer))
  1308. ;;    (byte-compile-from-buffer buffer nil))
  1309. ;;  (message "Compiling %s...done" (buffer-name buffer))
  1310. ;;  t)
  1311.  
  1312. ;;; compiling a single function
  1313. ;;;###autoload
  1314. (defun compile-defun (&optional arg)
  1315.   "Compile and evaluate the current top-level form.
  1316. Print the result in the minibuffer.
  1317. With argument, insert value in current buffer after the form."
  1318.   (interactive "P")
  1319.   (save-excursion
  1320.     (end-of-defun)
  1321.     (beginning-of-defun)
  1322.     (let* ((byte-compile-current-file nil)
  1323.        (byte-compile-last-warned-form 'nothing)
  1324.        (value (eval (displaying-byte-compile-warnings
  1325.              (byte-compile-sexp (read (current-buffer)))))))
  1326.       (cond (arg
  1327.          (message "Compiling from buffer... done.")
  1328.          (prin1 value (current-buffer))
  1329.          (insert "\n"))
  1330.         ((message "%s" (prin1-to-string value)))))))
  1331.  
  1332.  
  1333. (defun byte-compile-from-buffer (inbuffer &optional filename)
  1334.   ;; Filename is used for the loading-into-Emacs-18 error message.
  1335.   (let (outbuffer
  1336.     ;; Prevent truncation of flonums and lists as we read and print them
  1337.     (float-output-format nil)
  1338.     (case-fold-search nil)
  1339.     (print-length nil)
  1340.     (print-level nil)
  1341.     ;; Simulate entry to byte-compile-top-level
  1342.     (byte-compile-constants nil)
  1343.     (byte-compile-variables nil)
  1344.     (byte-compile-tag-number 0)
  1345.     (byte-compile-depth 0)
  1346.     (byte-compile-maxdepth 0)
  1347.     (byte-compile-output nil)
  1348.     ;;      #### This is bound in b-c-close-variables.
  1349.     ;;      (byte-compile-warnings (if (eq byte-compile-warnings t)
  1350.     ;;                     byte-compile-warning-types
  1351.     ;;                   byte-compile-warnings))
  1352.     )
  1353.     (byte-compile-close-variables
  1354.      (save-excursion
  1355.        (setq outbuffer
  1356.          (set-buffer (get-buffer-create " *Compiler Output*")))
  1357.        (erase-buffer)
  1358.        ;;     (emacs-lisp-mode)
  1359.        (setq case-fold-search nil)
  1360.        (and filename (byte-compile-insert-header filename inbuffer outbuffer))
  1361.  
  1362.        ;; This is a kludge.  Some operating systems (OS/2, DOS) need to
  1363.        ;; write files containing binary information specially.
  1364.        ;; Under most circumstances, such files will be in binary
  1365.        ;; overwrite mode, so those OS's use that flag to guess how
  1366.        ;; they should write their data.  Advise them that .elc files
  1367.        ;; need to be written carefully.
  1368.        (setq overwrite-mode 'overwrite-mode-binary))
  1369.      (displaying-byte-compile-warnings
  1370.       (save-excursion
  1371.     (set-buffer inbuffer)
  1372.     (goto-char 1)
  1373.  
  1374.     ;; Compile the forms from the input buffer.
  1375.     (while (progn
  1376.          (while (progn (skip-chars-forward " \t\n\^l")
  1377.                    (looking-at ";"))
  1378.            (forward-line 1))
  1379.          (not (eobp)))
  1380.       (byte-compile-file-form (read inbuffer)))
  1381.  
  1382.     ;; Compile pending forms at end of file.
  1383.     (byte-compile-flush-pending)
  1384.     (byte-compile-warn-about-unresolved-functions)
  1385.     ;; Should we always do this?  When calling multiple files, it
  1386.     ;; would be useful to delay this warning until all have
  1387.     ;; been compiled.
  1388.     (setq byte-compile-unresolved-functions nil))))
  1389.     outbuffer))
  1390.  
  1391. (defun byte-compile-insert-header (filename inbuffer outbuffer)
  1392.   (set-buffer inbuffer)
  1393.   (let ((dynamic-docstrings byte-compile-dynamic-docstrings))
  1394.     (set-buffer outbuffer)
  1395.     (goto-char 1)
  1396.     ;;
  1397.     ;; The magic number of .elc files is ";ELC", or 0x3B454C43.  After that is
  1398.     ;; the file-format version number (18 or 19) as a byte, followed by some
  1399.     ;; nulls.  The primary motivation for doing this is to get some binary
  1400.     ;; characters up in the first line of the file so that `diff' will simply
  1401.     ;; say "Binary files differ" instead of actually doing a diff of two .elc
  1402.     ;; files.  An extra benefit is that you can add this to /etc/magic:
  1403.     ;;
  1404.     ;; 0    string        ;ELC        GNU Emacs Lisp compiled file,
  1405.     ;; >4    byte        x        version %d
  1406.     ;;
  1407.     (insert
  1408.      ";ELC"
  1409.      (if (byte-compile-version-cond byte-compile-compatibility) 18 19)
  1410.      "\000\000\000\n"
  1411.      )
  1412.     (insert ";;; compiled by "
  1413.         (or (and (boundp 'user-mail-address) user-mail-address)
  1414.         (concat (user-login-name) "@" (system-name)))
  1415.         " on "
  1416.         (current-time-string) "\n;;; from file " filename "\n")
  1417.     (insert ";;; emacs version " emacs-version ".\n")
  1418.     (insert ";;; bytecomp version " byte-compile-version "\n;;; "
  1419.         (cond
  1420.          ((eq byte-optimize 'source) "source-level optimization only")
  1421.          ((eq byte-optimize 'byte) "byte-level optimization only")
  1422.          (byte-optimize "optimization is on")
  1423.          (t "optimization is off"))
  1424.         (if (byte-compile-version-cond byte-compile-compatibility)
  1425.         "; compiled with Emacs 18 compatibility.\n"
  1426.           ".\n"))
  1427.     (if (not (byte-compile-version-cond byte-compile-compatibility))
  1428.     (insert ";;; this file uses opcodes which do not exist in Emacs 18.\n"
  1429.         ;; Have to check if emacs-version is bound so that this works
  1430.         ;; in files loaded early in loadup.el.
  1431.         "\n(if (and (boundp 'emacs-version)\n"
  1432.         "\t (or (and (boundp 'epoch::version) epoch::version)\n"
  1433.         (if dynamic-docstrings
  1434.             "\t     (string-lessp emacs-version \"19.29\")))\n"
  1435.           "\t     (string-lessp emacs-version \"19\")))\n")
  1436.         "    (error \"`"
  1437.         ;; prin1-to-string is used to quote backslashes.
  1438.         (substring (prin1-to-string (file-name-nondirectory filename))
  1439.                1 -1)
  1440.         (if dynamic-docstrings
  1441.             "' was compiled for Emacs 19.29 or later\"))\n\n"
  1442.           "' was compiled for Emacs 19\"))\n\n"))
  1443.       (insert "(or (boundp 'current-load-list) (setq current-load-list nil))\n"
  1444.           "\n")
  1445.       )))
  1446.  
  1447.  
  1448. (defun byte-compile-output-file-form (form)
  1449.   ;; writes the given form to the output buffer, being careful of docstrings
  1450.   ;; in defun, defmacro, defvar, defconst and autoload because make-docfile is
  1451.   ;; so amazingly stupid.
  1452.   ;; defalias calls are output directly by byte-compile-file-form-defmumble;
  1453.   ;; it does not pay to first build the defalias in defmumble and then parse
  1454.   ;; it here.
  1455.   (if (and (memq (car-safe form) '(defun defmacro defvar defconst autoload))
  1456.        (stringp (nth 3 form)))
  1457.       (byte-compile-output-docform nil nil '("\n(" 3 ")") form nil
  1458.                    (eq (car form) 'autoload))
  1459.     (let ((print-escape-newlines t)
  1460.       (print-length nil)
  1461.       (print-level nil)
  1462.       (print-readably t)    ; print #[] for bytecode, 'x for (quote x)
  1463.       (print-gensym nil))    ; this is too dangerous for now
  1464.       (princ "\n" outbuffer)
  1465.       (prin1 form outbuffer)
  1466.       nil)))
  1467.  
  1468. (defun byte-compile-output-docform (preface name info form specindex quoted)
  1469.   "Print a form with a doc string.  INFO is (prefix doc-index postfix).
  1470. If PREFACE and NAME are non-nil, print them too,
  1471. before INFO and the FORM but after the doc string itself.
  1472. If SPECINDEX is non-nil, it is the index in FORM
  1473. of the function bytecode string.  In that case,
  1474. we output that argument and the following argument (the constants vector)
  1475. together, for lazy loading.
  1476. QUOTED says that we have to put a quote before the
  1477. list that represents a doc string reference.
  1478. `autoload' needs that."
  1479.   ;; We need to examine byte-compile-dynamic-docstrings
  1480.   ;; in the input buffer (now current), not in the output buffer.
  1481.   (let ((dynamic-docstrings byte-compile-dynamic-docstrings))
  1482.     (set-buffer
  1483.      (prog1 (current-buffer)
  1484.        (set-buffer outbuffer)
  1485.        (let (position)
  1486.  
  1487.      ;; Insert the doc string, and make it a comment with #@LENGTH.
  1488.      (and (>= (nth 1 info) 0)
  1489.           dynamic-docstrings
  1490.           (not byte-compile-compatibility)
  1491.           (progn
  1492.         ;; Make the doc string start at beginning of line
  1493.         ;; for make-docfile's sake.
  1494.         (insert "\n")
  1495.         (setq position
  1496.               (byte-compile-output-as-comment
  1497.                (nth (nth 1 info) form) nil))
  1498.         ;; If the doc string starts with * (a user variable),
  1499.         ;; negate POSITION.
  1500.         (if (and (stringp (nth (nth 1 info) form))
  1501.              (> (length (nth (nth 1 info) form)) 0)
  1502.              (eq (aref (nth (nth 1 info) form) 0) ?*))
  1503.             (setq position (- position)))))
  1504.  
  1505.      (if preface
  1506.          (progn
  1507.            (insert preface)
  1508.            (prin1 name outbuffer)))
  1509.      (insert (car info))
  1510.      (let ((print-escape-newlines t)
  1511.            (print-readably t)    ; print #[] for bytecode, 'x for (quote x)
  1512.            (print-gensym nil)    ; this is too dangerous for now
  1513.            (index 0))
  1514.        (prin1 (car form) outbuffer)
  1515.        (while (setq form (cdr form))
  1516.          (setq index (1+ index))
  1517.          (insert " ")
  1518.          (cond ((and (numberp specindex) (= index specindex))
  1519.             (let ((position
  1520.                (byte-compile-output-as-comment
  1521.                 (cons (car form) (nth 1 form))
  1522.                 t)))
  1523.               (princ (format "(#$ . %d) nil" position) outbuffer)
  1524.               (setq form (cdr form))
  1525.               (setq index (1+ index))))
  1526.            ((= index (nth 1 info))
  1527.             (if position
  1528.             (princ (format (if quoted "'(#$ . %d)"  "(#$ . %d)")
  1529.                        position)
  1530.                    outbuffer)
  1531.               (let ((print-escape-newlines nil))
  1532.             (goto-char (prog1 (1+ (point))
  1533.                      (prin1 (car form) outbuffer)))
  1534.             (insert "\\\n")
  1535.             (goto-char (point-max)))))
  1536.            (t
  1537.             (prin1 (car form) outbuffer)))))
  1538.      (insert (nth 2 info))))))
  1539.   nil)
  1540.  
  1541. (defun byte-compile-keep-pending (form &optional handler)
  1542.   (if (memq byte-optimize '(t source))
  1543.       (setq form (byte-optimize-form form t)))
  1544.   (if handler
  1545.       (let ((for-effect t))
  1546.     ;; To avoid consing up monstrously large forms at load time, we split
  1547.     ;; the output regularly.
  1548.     (and (memq (car-safe form) '(fset defalias))
  1549.          (nthcdr 300 byte-compile-output)
  1550.          (byte-compile-flush-pending))
  1551.     (funcall handler form)
  1552.     (if for-effect
  1553.         (byte-compile-discard)))
  1554.     (byte-compile-form form t))
  1555.   nil)
  1556.  
  1557. (defun byte-compile-flush-pending ()
  1558.   (if byte-compile-output
  1559.       (let ((form (byte-compile-out-toplevel t 'file)))
  1560.     (cond ((eq (car-safe form) 'progn)
  1561.            (mapcar 'byte-compile-output-file-form (cdr form)))
  1562.           (form
  1563.            (byte-compile-output-file-form form)))
  1564.     (setq byte-compile-constants nil
  1565.           byte-compile-variables nil
  1566.           byte-compile-depth 0
  1567.           byte-compile-maxdepth 0
  1568.           byte-compile-output nil))))
  1569.  
  1570. (defun byte-compile-file-form (form)
  1571.   (let ((byte-compile-current-form nil)    ; close over this for warnings.
  1572.     handler)
  1573.     (cond
  1574.      ((not (consp form))
  1575.       (byte-compile-keep-pending form))
  1576.      ((and (symbolp (car form))
  1577.        (setq handler (get (car form) 'byte-hunk-handler)))
  1578.       (cond ((setq form (funcall handler form))
  1579.          (byte-compile-flush-pending)
  1580.          (byte-compile-output-file-form form))))
  1581.      ((eq form (setq form (macroexpand form byte-compile-macro-environment)))
  1582.       (byte-compile-keep-pending form))
  1583.      (t
  1584.       (byte-compile-file-form form)))))
  1585.  
  1586. ;; Functions and variables with doc strings must be output separately,
  1587. ;; so make-docfile can recognise them.  Most other things can be output
  1588. ;; as byte-code.
  1589.  
  1590. (put 'defsubst 'byte-hunk-handler 'byte-compile-file-form-defsubst)
  1591. (defun byte-compile-file-form-defsubst (form)
  1592.   (cond ((assq (nth 1 form) byte-compile-unresolved-functions)
  1593.      (setq byte-compile-current-form (nth 1 form))
  1594.      (byte-compile-warn "defsubst %s was used before it was defined"
  1595.                 (nth 1 form))))
  1596.   (byte-compile-file-form
  1597.    (macroexpand form byte-compile-macro-environment))
  1598.   ;; Return nil so the form is not output twice.
  1599.   nil)
  1600.  
  1601. (put 'autoload 'byte-hunk-handler 'byte-compile-file-form-autoload)
  1602. (defun byte-compile-file-form-autoload (form)
  1603.   (and (let ((form form))
  1604.      (while (if (setq form (cdr form)) (byte-compile-constp (car form))))
  1605.      (null form))            ;Constants only
  1606.        (eval (nth 5 form))        ;Macro
  1607.        (eval form))            ;Define the autoload.
  1608.   (if (stringp (nth 3 form))
  1609.       form
  1610.     ;; No doc string, so we can compile this as a normal form.
  1611.     (byte-compile-keep-pending form 'byte-compile-normal-call)))
  1612.  
  1613. (put 'defvar   'byte-hunk-handler 'byte-compile-file-form-defvar)
  1614. (put 'defconst 'byte-hunk-handler 'byte-compile-file-form-defvar)
  1615. (defun byte-compile-file-form-defvar (form)
  1616.   (if (null (nth 3 form))
  1617.       ;; Since there is no doc string, we can compile this as a normal form,
  1618.       ;; and not do a file-boundary.
  1619.       (byte-compile-keep-pending form)
  1620.     (if (memq 'free-vars byte-compile-warnings)
  1621.     (setq byte-compile-bound-variables
  1622.           (cons (nth 1 form) byte-compile-bound-variables)))
  1623.     (cond ((consp (nth 2 form))
  1624.        (setq form (copy-sequence form))
  1625.        (setcar (cdr (cdr form))
  1626.            (byte-compile-top-level (nth 2 form) nil 'file))))
  1627.     form))
  1628.  
  1629. (put 'require 'byte-hunk-handler 'byte-compile-file-form-eval-boundary)
  1630. (defun byte-compile-file-form-eval-boundary (form)
  1631.   (eval form)
  1632.   (byte-compile-keep-pending form 'byte-compile-normal-call))
  1633.  
  1634. (put 'progn 'byte-hunk-handler 'byte-compile-file-form-progn)
  1635. (put 'prog1 'byte-hunk-handler 'byte-compile-file-form-progn)
  1636. (put 'prog2 'byte-hunk-handler 'byte-compile-file-form-progn)
  1637. (defun byte-compile-file-form-progn (form)
  1638.   (mapcar 'byte-compile-file-form (cdr form))
  1639.   ;; Return nil so the forms are not output twice.
  1640.   nil)
  1641.  
  1642. ;; This handler is not necessary, but it makes the output from dont-compile
  1643. ;; and similar macros cleaner.
  1644. (put 'eval 'byte-hunk-handler 'byte-compile-file-form-eval)
  1645. (defun byte-compile-file-form-eval (form)
  1646.   (if (eq (car-safe (nth 1 form)) 'quote)
  1647.       (nth 1 (nth 1 form))
  1648.     (byte-compile-keep-pending form)))
  1649.  
  1650. (put 'defun 'byte-hunk-handler 'byte-compile-file-form-defun)
  1651. (defun byte-compile-file-form-defun (form)
  1652.   (byte-compile-file-form-defmumble form nil))
  1653.  
  1654. (put 'defmacro 'byte-hunk-handler 'byte-compile-file-form-defmacro)
  1655. (defun byte-compile-file-form-defmacro (form)
  1656.   (byte-compile-file-form-defmumble form t))
  1657.  
  1658. (defun byte-compile-file-form-defmumble (form macrop)
  1659.   (let* ((name (car (cdr form)))
  1660.      (this-kind (if macrop 'byte-compile-macro-environment
  1661.               'byte-compile-function-environment))
  1662.      (that-kind (if macrop 'byte-compile-function-environment
  1663.               'byte-compile-macro-environment))
  1664.      (this-one (assq name (symbol-value this-kind)))
  1665.      (that-one (assq name (symbol-value that-kind)))
  1666.      (byte-compile-free-references nil)
  1667.      (byte-compile-free-assignments nil))
  1668.  
  1669.     ;; When a function or macro is defined, add it to the call tree so that
  1670.     ;; we can tell when functions are not used.
  1671.     (if byte-compile-generate-call-tree
  1672.     (or (assq name byte-compile-call-tree)
  1673.         (setq byte-compile-call-tree
  1674.           (cons (list name nil nil) byte-compile-call-tree))))
  1675.  
  1676.     (setq byte-compile-current-form name) ; for warnings
  1677.     (if (memq 'redefine byte-compile-warnings)
  1678.     (byte-compile-arglist-warn form macrop))
  1679.     (if byte-compile-verbose
  1680.     (message "Compiling %s... (%s)" (or filename "") (nth 1 form)))
  1681.     (cond (that-one
  1682.        (if (and (memq 'redefine byte-compile-warnings)
  1683.             ;; don't warn when compiling the stubs in byte-run...
  1684.             (not (assq (nth 1 form)
  1685.                    byte-compile-initial-macro-environment)))
  1686.            (byte-compile-warn
  1687.          "%s defined multiple times, as both function and macro"
  1688.          (nth 1 form)))
  1689.        (setcdr that-one nil))
  1690.       (this-one
  1691.        (if (and (memq 'redefine byte-compile-warnings)
  1692.             ;; hack: don't warn when compiling the magic internal
  1693.             ;; byte-compiler macros in byte-run.el...
  1694.             (not (assq (nth 1 form)
  1695.                    byte-compile-initial-macro-environment)))
  1696.            (byte-compile-warn "%s %s defined multiple times in this file"
  1697.                   (if macrop "macro" "function")
  1698.                   (nth 1 form))))
  1699.       ((and (fboundp name)
  1700.         (eq (car-safe (symbol-function name))
  1701.             (if macrop 'lambda 'macro)))
  1702.        (if (memq 'redefine byte-compile-warnings)
  1703.            (byte-compile-warn "%s %s being redefined as a %s"
  1704.                   (if macrop "function" "macro")
  1705.                   (nth 1 form)
  1706.                   (if macrop "macro" "function")))
  1707.        ;; shadow existing definition
  1708.        (set this-kind
  1709.         (cons (cons name nil) (symbol-value this-kind))))
  1710.       )
  1711.     (let ((body (nthcdr 3 form)))
  1712.       (if (and (stringp (car body))
  1713.            (symbolp (car-safe (cdr-safe body)))
  1714.            (car-safe (cdr-safe body))
  1715.            (stringp (car-safe (cdr-safe (cdr-safe body)))))
  1716.       (byte-compile-warn "Probable `\"' without `\\' in doc string of %s"
  1717.                  (nth 1 form))))
  1718.     (let* ((new-one (byte-compile-lambda (cons 'lambda (nthcdr 2 form))))
  1719.        (code (byte-compile-byte-code-maker new-one)))
  1720.       (if this-one
  1721.       (setcdr this-one new-one)
  1722.     (set this-kind
  1723.          (cons (cons name new-one) (symbol-value this-kind))))
  1724.       (if (and (stringp (nth 3 form))
  1725.            (eq 'quote (car-safe code))
  1726.            (eq 'lambda (car-safe (nth 1 code))))
  1727.       (cons (car form)
  1728.         (cons name (cdr (nth 1 code))))
  1729.     (byte-compile-flush-pending)
  1730.     (if (not (stringp (nth 3 form)))
  1731.         ;; No doc string.  Provide -1 as the "doc string index"
  1732.         ;; so that no element will be treated as a doc string.
  1733.         (byte-compile-output-docform
  1734.          (if (byte-compile-version-cond byte-compile-compatibility)
  1735.          "\n(fset '" "\n(defalias '")
  1736.          name
  1737.          (cond ((atom code)
  1738.             (if macrop '(" '(macro . #[" -1 "])") '(" #[" -1 "]")))
  1739.            ((eq (car code) 'quote)
  1740.             (setq code new-one)
  1741.             (if macrop '(" '(macro " -1 ")") '(" '(" -1 ")")))
  1742.            ((if macrop '(" (cons 'macro (" -1 "))") '(" (" -1 ")"))))
  1743.          (append code nil)
  1744.          (and (atom code) byte-compile-dynamic
  1745.           1)
  1746.          nil)
  1747.       ;; Output the form by hand, that's much simpler than having
  1748.       ;; b-c-output-file-form analyze the defalias.
  1749.       (byte-compile-output-docform
  1750.        (if (byte-compile-version-cond byte-compile-compatibility)
  1751.            "\n(fset '" "\n(defalias '")
  1752.        name
  1753.        (cond ((atom code)
  1754.           (if macrop '(" '(macro . #[" 4 "])") '(" #[" 4 "]")))
  1755.          ((eq (car code) 'quote)
  1756.           (setq code new-one)
  1757.           (if macrop '(" '(macro " 2 ")") '(" '(" 2 ")")))
  1758.          ((if macrop '(" (cons 'macro (" 5 "))") '(" (" 5 ")"))))
  1759.        (append code nil)
  1760.        (and (atom code) byte-compile-dynamic
  1761.         1)
  1762.        nil))
  1763.     (princ ")" outbuffer)
  1764.     nil))))
  1765.  
  1766. ;; Print Lisp object EXP in the output file, inside a comment,
  1767. ;; and return the file position it will have.
  1768. ;; If QUOTED is non-nil, print with quoting; otherwise, print without quoting.
  1769. (defun byte-compile-output-as-comment (exp quoted)
  1770.   (let ((position (point)))
  1771.     (set-buffer
  1772.      (prog1 (current-buffer)
  1773.        (set-buffer outbuffer)
  1774.  
  1775.        ;; Insert EXP, and make it a comment with #@LENGTH.
  1776.        (insert " ")
  1777.        (if quoted
  1778.        (prin1 exp outbuffer)
  1779.      (princ exp outbuffer))
  1780.        (goto-char position)
  1781.        ;; Quote certain special characters as needed.
  1782.        ;; get_doc_string in doc.c does the unquoting.
  1783.        (while (search-forward "\^A" nil t)
  1784.      (replace-match "\^A\^A" t t))
  1785.        (goto-char position)
  1786.        (while (search-forward "\000" nil t)
  1787.      (replace-match "\^A0" t t))
  1788.        (goto-char position)
  1789.        (while (search-forward "\037" nil t)
  1790.      (replace-match "\^A_" t t))
  1791.        (goto-char (point-max))
  1792.        (insert "\037")
  1793.        (goto-char position)
  1794.        (insert "#@" (format "%d" (- (point-max) position)))
  1795.  
  1796.        ;; Save the file position of the object.
  1797.        ;; Note we should add 1 to skip the space
  1798.        ;; that we inserted before the actual doc string,
  1799.        ;; and subtract 1 to convert from an 1-origin Emacs position
  1800.        ;; to a file position; they cancel.
  1801.        (setq position (point))
  1802.        (goto-char (point-max))))
  1803.     position))
  1804.  
  1805.  
  1806.  
  1807. ;;;###autoload
  1808. (defun byte-compile (form)
  1809.   "If FORM is a symbol, byte-compile its function definition.
  1810. If FORM is a lambda or a macro, byte-compile it as a function."
  1811.   (displaying-byte-compile-warnings
  1812.    (byte-compile-close-variables
  1813.     (let* ((fun (if (symbolp form)
  1814.             (and (fboundp form) (symbol-function form))
  1815.           form))
  1816.        (macro (eq (car-safe fun) 'macro)))
  1817.       (if macro
  1818.       (setq fun (cdr fun)))
  1819.       (cond ((eq (car-safe fun) 'lambda)
  1820.          (setq fun (if macro
  1821.                (cons 'macro (byte-compile-lambda fun))
  1822.              (byte-compile-lambda fun)))
  1823.          (if (symbolp form)
  1824.          (defalias form fun)
  1825.            fun)))))))
  1826.  
  1827. (defun byte-compile-sexp (sexp)
  1828.   "Compile and return SEXP."
  1829.   (displaying-byte-compile-warnings
  1830.    (byte-compile-close-variables
  1831.     (byte-compile-top-level sexp))))
  1832.  
  1833. ;; Given a function made by byte-compile-lambda, make a form which produces it.
  1834. (defun byte-compile-byte-code-maker (fun)
  1835.   (cond
  1836.    ((byte-compile-version-cond byte-compile-compatibility)
  1837.     ;; Return (quote (lambda ...)).
  1838.     (list 'quote (byte-compile-byte-code-unmake fun)))
  1839.    ;; ## atom is faster than compiled-func-p.
  1840.    ((atom fun)                ; compiled function.
  1841.     ;; generate-emacs19-bytecodes must be on, otherwise byte-compile-lambda
  1842.     ;; would have produced a lambda.
  1843.     fun)
  1844.    ;; b-c-lambda didn't produce a compiled-function, so it's either a trivial
  1845.    ;; function, or this is Emacs 18, or generate-emacs19-bytecodes is off.
  1846.    ((let (tmp)
  1847.       (if (and (setq tmp (assq 'byte-code (cdr-safe (cdr fun))))
  1848.            (null (cdr (memq tmp fun))))
  1849.       ;; Generate a make-byte-code call.
  1850.       (let* ((interactive (assq 'interactive (cdr (cdr fun)))))
  1851.         (nconc (list 'make-byte-code
  1852.              (list 'quote (nth 1 fun)) ;arglist
  1853.              (nth 1 tmp)    ;bytes
  1854.              (nth 2 tmp)    ;consts
  1855.              (nth 3 tmp))    ;depth
  1856.            (cond ((stringp (nth 2 fun))
  1857.               (list (nth 2 fun))) ;doc
  1858.              (interactive
  1859.               (list nil)))
  1860.            (cond (interactive
  1861.               (list (if (or (null (nth 1 interactive))
  1862.                     (stringp (nth 1 interactive)))
  1863.                     (nth 1 interactive)
  1864.                   ;; Interactive spec is a list or a variable
  1865.                   ;; (if it is correct).
  1866.                   (list 'quote (nth 1 interactive))))))))
  1867.     ;; a non-compiled function (probably trivial)
  1868.     (list 'quote fun))))))
  1869.  
  1870. ;; Turn a function into an ordinary lambda.  Needed for v18 files.
  1871. (defun byte-compile-byte-code-unmake (function)
  1872.   (if (consp function)
  1873.       function;;It already is a lambda.
  1874.     (setq function (append function nil)) ; turn it into a list
  1875.     (nconc (list 'lambda (nth 0 function))
  1876.        (and (nth 4 function) (list (nth 4 function)))
  1877.        (if (nthcdr 5 function)
  1878.            (list (cons 'interactive (if (nth 5 function)
  1879.                         (nthcdr 5 function)))))
  1880.        (list (list 'byte-code
  1881.                (nth 1 function) (nth 2 function)
  1882.                (nth 3 function))))))
  1883.  
  1884.  
  1885. ;; Byte-compile a lambda-expression and return a valid function.
  1886. ;; The value is usually a compiled function but may be the original
  1887. ;; lambda-expression.
  1888. (defun byte-compile-lambda (fun)
  1889.   (let* ((arglist (nth 1 fun))
  1890.      (byte-compile-bound-variables
  1891.       (nconc (and (memq 'free-vars byte-compile-warnings)
  1892.               (delq '&rest (delq '&optional (copy-sequence arglist))))
  1893.          byte-compile-bound-variables))
  1894.      (body (cdr (cdr fun)))
  1895.      (doc (if (stringp (car body))
  1896.           (prog1 (car body)
  1897.             (setq body (cdr body)))))
  1898.      (int (assq 'interactive body)))
  1899.     (cond (int
  1900.        ;; Skip (interactive) if it is in front (the most usual location).
  1901.        (if (eq int (car body))
  1902.            (setq body (cdr body)))
  1903.        (cond ((consp (cdr int))
  1904.           (if (cdr (cdr int))
  1905.               (byte-compile-warn "malformed interactive spec: %s"
  1906.                      (prin1-to-string int)))
  1907.           ;; If the interactive spec is a call to `list',
  1908.           ;; don't compile it, because `call-interactively'
  1909.           ;; looks at the args of `list'.
  1910.           (let ((form (nth 1 int)))
  1911.             (while (or (eq (car-safe form) 'let)
  1912.                    (eq (car-safe form) 'let*)
  1913.                    (eq (car-safe form) 'save-excursion))
  1914.               (while (consp (cdr form))
  1915.             (setq form (cdr form)))
  1916.               (setq form (car form)))
  1917.             (or (eq (car-safe form) 'list)
  1918.             (setq int (list 'interactive
  1919.                     (byte-compile-top-level (nth 1 int)))))))
  1920.          ((cdr int)
  1921.           (byte-compile-warn "malformed interactive spec: %s"
  1922.                      (prin1-to-string int))))))
  1923.     (let ((compiled (byte-compile-top-level (cons 'progn body) nil 'lambda)))
  1924.       (if (and (eq 'byte-code (car-safe compiled))
  1925.            (not (byte-compile-version-cond
  1926.              byte-compile-compatibility)))
  1927.       (apply 'make-byte-code
  1928.          (append (list arglist)
  1929.              ;; byte-string, constants-vector, stack depth
  1930.              (cdr compiled)
  1931.              ;; optionally, the doc string.
  1932.              (if (or doc int)
  1933.                  (list doc))
  1934.              ;; optionally, the interactive spec.
  1935.              (if int
  1936.                  (list (nth 1 int)))))
  1937.     (setq compiled
  1938.           (nconc (if int (list int))
  1939.              (cond ((eq (car-safe compiled) 'progn) (cdr compiled))
  1940.                (compiled (list compiled)))))
  1941.     (nconc (list 'lambda arglist)
  1942.            (if (or doc (stringp (car compiled)))
  1943.            (cons doc (cond (compiled)
  1944.                    (body (list nil))))
  1945.          compiled))))))
  1946.  
  1947. (defun byte-compile-constants-vector ()
  1948.   ;; Builds the constants-vector from the current variables and constants.
  1949.   ;;   This modifies the constants from (const . nil) to (const . offset).
  1950.   ;; To keep the byte-codes to look up the vector as short as possible:
  1951.   ;;   First 6 elements are vars, as there are one-byte varref codes for those.
  1952.   ;;   Next up to byte-constant-limit are constants, still with one-byte codes.
  1953.   ;;   Next variables again, to get 2-byte codes for variable lookup.
  1954.   ;;   The rest of the constants and variables need 3-byte byte-codes.
  1955.   (let* ((i -1)
  1956.      (rest (nreverse byte-compile-variables)) ; nreverse because the first
  1957.      (other (nreverse byte-compile-constants)) ; vars often are used most.
  1958.      ret tmp
  1959.      (limits '(5            ; Use the 1-byte varref codes,
  1960.            63  ; 1-constlim    ;  1-byte byte-constant codes,
  1961.            255            ;  2-byte varref codes,
  1962.            65535))        ;  3-byte codes for the rest.
  1963.      limit)
  1964.     (while (or rest other)
  1965.       (setq limit (car limits))
  1966.       (while (and rest (not (eq i limit)))
  1967.     (if (setq tmp (assq (car (car rest)) ret))
  1968.         (setcdr (car rest) (cdr tmp))
  1969.       (setcdr (car rest) (setq i (1+ i)))
  1970.       (setq ret (cons (car rest) ret)))
  1971.     (setq rest (cdr rest)))
  1972.       (setq limits (cdr limits)
  1973.         rest (prog1 other
  1974.            (setq other rest))))
  1975.     (apply 'vector (nreverse (mapcar 'car ret)))))
  1976.  
  1977. ;; Given an expression FORM, compile it and return an equivalent byte-code
  1978. ;; expression (a call to the function byte-code).
  1979. (defun byte-compile-top-level (form &optional for-effect output-type)
  1980.   ;; OUTPUT-TYPE advises about how form is expected to be used:
  1981.   ;;    'eval or nil    -> a single form,
  1982.   ;;    'progn or t    -> a list of forms,
  1983.   ;;    'lambda        -> body of a lambda,
  1984.   ;;    'file        -> used at file-level.
  1985.   (let ((byte-compile-constants nil)
  1986.     (byte-compile-variables nil)
  1987.     (byte-compile-tag-number 0)
  1988.     (byte-compile-depth 0)
  1989.     (byte-compile-maxdepth 0)
  1990.     (byte-compile-output nil))
  1991.      (if (memq byte-optimize '(t source))
  1992.      (setq form (byte-optimize-form form for-effect)))
  1993.      (while (and (eq (car-safe form) 'progn) (null (cdr (cdr form))))
  1994.        (setq form (nth 1 form)))
  1995.      (if (and (eq 'byte-code (car-safe form))
  1996.           (not (memq byte-optimize '(t byte)))
  1997.           (stringp (nth 1 form)) (vectorp (nth 2 form))
  1998.           (natnump (nth 3 form)))
  1999.      form
  2000.        (byte-compile-form form for-effect)
  2001.        (byte-compile-out-toplevel for-effect output-type))))
  2002.  
  2003. (defun byte-compile-out-toplevel (&optional for-effect output-type)
  2004.   (if for-effect
  2005.       ;; The stack is empty. Push a value to be returned from (byte-code ..).
  2006.       (if (eq (car (car byte-compile-output)) 'byte-discard)
  2007.       (setq byte-compile-output (cdr byte-compile-output))
  2008.     (byte-compile-push-constant
  2009.      ;; Push any constant - preferably one which already is used, and
  2010.      ;; a number or symbol - ie not some big sequence.  The return value
  2011.      ;; isn't returned, but it would be a shame if some textually large
  2012.      ;; constant was not optimized away because we chose to return it.
  2013.      (and (not (assq nil byte-compile-constants)) ; Nil is often there.
  2014.           (let ((tmp (reverse byte-compile-constants)))
  2015.         (while (and tmp (not (or (symbolp (car (car tmp)))
  2016.                      (numberp (car (car tmp))))))
  2017.           (setq tmp (cdr tmp)))
  2018.         (car (car tmp)))))))
  2019.   (byte-compile-out 'byte-return 0)
  2020.   (setq byte-compile-output (nreverse byte-compile-output))
  2021.   (if (memq byte-optimize '(t byte))
  2022.       (setq byte-compile-output
  2023.         (byte-optimize-lapcode byte-compile-output for-effect)))
  2024.   
  2025.   ;; Decompile trivial functions:
  2026.   ;; only constants and variables, or a single funcall except in lambdas.
  2027.   ;; Except for Lisp_Compiled objects, forms like (foo "hi")
  2028.   ;; are still quicker than (byte-code "..." [foo "hi"] 2).
  2029.   ;; Note that even (quote foo) must be parsed just as any subr by the
  2030.   ;; interpreter, so quote should be compiled into byte-code in some contexts.
  2031.   ;; What to leave uncompiled:
  2032.   ;;    lambda    -> never.  we used to leave it uncompiled if the body was
  2033.   ;;           a single atom, but that causes confusion if the docstring
  2034.   ;;           uses the (file . pos) syntax.  Besides, now that we have
  2035.   ;;           the Lisp_Compiled type, the compiled form is faster.
  2036.   ;;    eval    -> atom, quote or (function atom atom atom)
  2037.   ;;    progn    -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
  2038.   ;;    file    -> as progn, but takes both quotes and atoms, and longer forms.
  2039.   (let (rest
  2040.     (maycall (not (eq output-type 'lambda))) ; t if we may make a funcall.
  2041.     tmp body)
  2042.     (cond
  2043.      ;; #### This should be split out into byte-compile-nontrivial-function-p.
  2044.      ((or (eq output-type 'lambda)
  2045.       (nthcdr (if (eq output-type 'file) 50 8) byte-compile-output)
  2046.       (assq 'TAG byte-compile-output) ; Not necessary, but speeds up a bit.
  2047.       (not (setq tmp (assq 'byte-return byte-compile-output)))
  2048.       (progn
  2049.         (setq rest (nreverse
  2050.             (cdr (memq tmp (reverse byte-compile-output)))))
  2051.         (while (cond
  2052.             ((memq (car (car rest)) '(byte-varref byte-constant))
  2053.              (setq tmp (car (cdr (car rest))))
  2054.              (if (if (eq (car (car rest)) 'byte-constant)
  2055.                  (or (consp tmp)
  2056.                  (and (symbolp tmp)
  2057.                       (not (memq tmp '(nil t))))))
  2058.              (if maycall
  2059.                  (setq body (cons (list 'quote tmp) body)))
  2060.                (setq body (cons tmp body))))
  2061.             ((and maycall
  2062.               ;; Allow a funcall if at most one atom follows it.
  2063.               (null (nthcdr 3 rest))
  2064.               (setq tmp (get (car (car rest)) 'byte-opcode-invert))
  2065.               (or (null (cdr rest))
  2066.                   (and (memq output-type '(file progn t))
  2067.                    (cdr (cdr rest))
  2068.                    (eq (car (nth 1 rest)) 'byte-discard)
  2069.                    (progn (setq rest (cdr rest)) t))))
  2070.              (setq maycall nil)    ; Only allow one real function call.
  2071.              (setq body (nreverse body))
  2072.              (setq body (list
  2073.                  (if (and (eq tmp 'funcall)
  2074.                       (eq (car-safe (car body)) 'quote))
  2075.                      (cons (nth 1 (car body)) (cdr body))
  2076.                    (cons tmp body))))
  2077.              (or (eq output-type 'file)
  2078.              (not (delq nil (mapcar 'consp (cdr (car body))))))))
  2079.           (setq rest (cdr rest)))
  2080.         rest))
  2081.       (let ((byte-compile-vector (byte-compile-constants-vector)))
  2082.     (list 'byte-code (byte-compile-lapcode byte-compile-output)
  2083.           byte-compile-vector byte-compile-maxdepth)))
  2084.      ;; it's a trivial function
  2085.      ((cdr body) (cons 'progn (nreverse body)))
  2086.      ((car body)))))
  2087.  
  2088. ;; Given BODY, compile it and return a new body.
  2089. (defun byte-compile-top-level-body (body &optional for-effect)
  2090.   (setq body (byte-compile-top-level (cons 'progn body) for-effect t))
  2091.   (cond ((eq (car-safe body) 'progn)
  2092.      (cdr body))
  2093.     (body
  2094.      (list body))))
  2095.  
  2096. ;; This is the recursive entry point for compiling each subform of an 
  2097. ;; expression.
  2098. ;; If for-effect is non-nil, byte-compile-form will output a byte-discard
  2099. ;; before terminating (ie no value will be left on the stack).
  2100. ;; A byte-compile handler may, when for-effect is non-nil, choose output code
  2101. ;; which does not leave a value on the stack, and then set for-effect to nil
  2102. ;; (to prevent byte-compile-form from outputting the byte-discard).
  2103. ;; If a handler wants to call another handler, it should do so via
  2104. ;; byte-compile-form, or take extreme care to handle for-effect correctly.
  2105. ;; (Use byte-compile-form-do-effect to reset the for-effect flag too.)
  2106. ;;
  2107. (defun byte-compile-form (form &optional for-effect)
  2108.   (setq form (macroexpand form byte-compile-macro-environment))
  2109.   (cond ((not (consp form))
  2110.      (cond ((or (not (symbolp form)) (memq form '(nil t)))
  2111.         (byte-compile-constant form))
  2112.            ((and for-effect byte-compile-delete-errors)
  2113.         (setq for-effect nil))
  2114.            (t (byte-compile-variable-ref 'byte-varref form))))
  2115.     ((symbolp (car form))
  2116.      (let* ((fn (car form))
  2117.         (handler (get fn 'byte-compile)))
  2118.        (if (memq fn '(t nil))
  2119.            (byte-compile-warn "%s called as a function" fn))
  2120.        (if (and handler
  2121.             (or (not (byte-compile-version-cond
  2122.                   byte-compile-compatibility))
  2123.             (not (get (get fn 'byte-opcode) 'emacs19-opcode))))
  2124.            (funcall handler form)
  2125.          (if (memq 'callargs byte-compile-warnings)
  2126.          (byte-compile-callargs-warn form))
  2127.          (byte-compile-normal-call form))))
  2128.     ((and (or (byte-code-function-p (car form))
  2129.           (eq (car-safe (car form)) 'lambda))
  2130.           ;; if the form comes out the same way it went in, that's
  2131.           ;; because it was malformed, and we couldn't unfold it.
  2132.           (not (eq form (setq form (byte-compile-unfold-lambda form)))))
  2133.      (byte-compile-form form for-effect)
  2134.      (setq for-effect nil))
  2135.     ((byte-compile-normal-call form)))
  2136.   (if for-effect
  2137.       (byte-compile-discard)))
  2138.  
  2139. (defun byte-compile-normal-call (form)
  2140.   (if byte-compile-generate-call-tree
  2141.       (byte-compile-annotate-call-tree form))
  2142.   (byte-compile-push-constant (car form))
  2143.   (mapcar 'byte-compile-form (cdr form)) ; wasteful, but faster.
  2144.   (byte-compile-out 'byte-call (length (cdr form))))
  2145.  
  2146. (defun byte-compile-variable-ref (base-op var)
  2147.   (if (or (not (symbolp var)) (memq var '(nil t)))
  2148.       (byte-compile-warn (if (eq base-op 'byte-varbind)
  2149.                  "Attempt to let-bind %s %s"
  2150.                "Variable reference to %s %s")
  2151.              (if (symbolp var) "constant" "nonvariable")
  2152.              (prin1-to-string var))
  2153.     (if (and (get var 'byte-obsolete-variable)
  2154.          (memq 'obsolete byte-compile-warnings))
  2155.     (let ((ob (get var 'byte-obsolete-variable)))
  2156.       (byte-compile-warn "%s is an obsolete variable; %s" var
  2157.                  (if (stringp ob)
  2158.                  ob
  2159.                    (format "use %s instead." ob)))))
  2160.     (if (memq 'free-vars byte-compile-warnings)
  2161.     (if (eq base-op 'byte-varbind)
  2162.         (setq byte-compile-bound-variables
  2163.           (cons var byte-compile-bound-variables))
  2164.       (or (boundp var)
  2165.           (memq var byte-compile-bound-variables)
  2166.           (if (eq base-op 'byte-varset)
  2167.           (or (memq var byte-compile-free-assignments)
  2168.               (progn
  2169.             (byte-compile-warn "assignment to free variable %s" var)
  2170.             (setq byte-compile-free-assignments
  2171.                   (cons var byte-compile-free-assignments))))
  2172.         (or (memq var byte-compile-free-references)
  2173.             (progn
  2174.               (byte-compile-warn "reference to free variable %s" var)
  2175.               (setq byte-compile-free-references
  2176.                 (cons var byte-compile-free-references)))))))))
  2177.   (let ((tmp (assq var byte-compile-variables)))
  2178.     (or tmp
  2179.     (setq tmp (list var)
  2180.           byte-compile-variables (cons tmp byte-compile-variables)))
  2181.     (byte-compile-out base-op tmp)))
  2182.  
  2183. (defmacro byte-compile-get-constant (const)
  2184.   (` (or (if (stringp (, const))
  2185.          (assoc (, const) byte-compile-constants)
  2186.        (assq (, const) byte-compile-constants))
  2187.      (car (setq byte-compile-constants
  2188.             (cons (list (, const)) byte-compile-constants))))))
  2189.  
  2190. ;; Use this when the value of a form is a constant.  This obeys for-effect.
  2191. (defun byte-compile-constant (const)
  2192.   (if for-effect
  2193.       (setq for-effect nil)
  2194.     (byte-compile-out 'byte-constant (byte-compile-get-constant const))))
  2195.  
  2196. ;; Use this for a constant that is not the value of its containing form.
  2197. ;; This ignores for-effect.
  2198. (defun byte-compile-push-constant (const)
  2199.   (let ((for-effect nil))
  2200.     (inline (byte-compile-constant const))))
  2201.  
  2202.  
  2203. ;; Compile those primitive ordinary functions
  2204. ;; which have special byte codes just for speed.
  2205.  
  2206. (defmacro byte-defop-compiler (function &optional compile-handler)
  2207.   ;; add a compiler-form for FUNCTION.
  2208.   ;; If function is a symbol, then the variable "byte-SYMBOL" must name
  2209.   ;; the opcode to be used.  If function is a list, the first element
  2210.   ;; is the function and the second element is the bytecode-symbol.
  2211.   ;; COMPILE-HANDLER is the function to use to compile this byte-op, or
  2212.   ;; may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
  2213.   ;; If it is nil, then the handler is "byte-compile-SYMBOL."
  2214.   (let (opcode)
  2215.     (if (symbolp function)
  2216.     (setq opcode (intern (concat "byte-" (symbol-name function))))
  2217.       (setq opcode (car (cdr function))
  2218.         function (car function)))
  2219.     (let ((fnform
  2220.        (list 'put (list 'quote function) ''byte-compile
  2221.          (list 'quote
  2222.                (or (cdr (assq compile-handler
  2223.                       '((0 . byte-compile-no-args)
  2224.                     (1 . byte-compile-one-arg)
  2225.                     (2 . byte-compile-two-args)
  2226.                     (3 . byte-compile-three-args)
  2227.                     (0-1 . byte-compile-zero-or-one-arg)
  2228.                     (1-2 . byte-compile-one-or-two-args)
  2229.                     (2-3 . byte-compile-two-or-three-args)
  2230.                     )))
  2231.                compile-handler
  2232.                (intern (concat "byte-compile-"
  2233.                        (symbol-name function))))))))
  2234.       (if opcode
  2235.       (list 'progn fnform
  2236.         (list 'put (list 'quote function)
  2237.               ''byte-opcode (list 'quote opcode))
  2238.         (list 'put (list 'quote opcode)
  2239.               ''byte-opcode-invert (list 'quote function)))
  2240.     fnform))))
  2241.  
  2242. (defmacro byte-defop-compiler19 (function &optional compile-handler)
  2243.   ;; Just like byte-defop-compiler, but defines an opcode that will only
  2244.   ;; be used when byte-compile-compatibility is false.
  2245.   (if (and (byte-compile-single-version)
  2246.        byte-compile-compatibility)
  2247.       ;; #### instead of doing nothing, this should do some remprops,
  2248.       ;; #### to protect against the case where a single-version compiler
  2249.       ;; #### is loaded into a world that has contained a multi-version one.
  2250.       nil
  2251.     (list 'progn
  2252.       (list 'put
  2253.     (list 'quote
  2254.       (or (car (cdr-safe function))
  2255.           (intern (concat "byte-"
  2256.                 (symbol-name (or (car-safe function) function))))))
  2257.     ''emacs19-opcode t)
  2258.       (list 'byte-defop-compiler function compile-handler))))
  2259.  
  2260. (defmacro byte-defop-compiler-1 (function &optional compile-handler)
  2261.   (list 'byte-defop-compiler (list function nil) compile-handler))
  2262.  
  2263.  
  2264. (put 'byte-call 'byte-opcode-invert 'funcall)
  2265. (put 'byte-list1 'byte-opcode-invert 'list)
  2266. (put 'byte-list2 'byte-opcode-invert 'list)
  2267. (put 'byte-list3 'byte-opcode-invert 'list)
  2268. (put 'byte-list4 'byte-opcode-invert 'list)
  2269. (put 'byte-listN 'byte-opcode-invert 'list)
  2270. (put 'byte-concat2 'byte-opcode-invert 'concat)
  2271. (put 'byte-concat3 'byte-opcode-invert 'concat)
  2272. (put 'byte-concat4 'byte-opcode-invert 'concat)
  2273. (put 'byte-concatN 'byte-opcode-invert 'concat)
  2274. (put 'byte-insertN 'byte-opcode-invert 'insert)
  2275.  
  2276. (byte-defop-compiler (dot byte-point)        0)
  2277. (byte-defop-compiler (dot-max byte-point-max)    0)
  2278. (byte-defop-compiler (dot-min byte-point-min)    0)
  2279. (byte-defop-compiler point        0)
  2280. ;;(byte-defop-compiler mark        0) ;; obsolete
  2281. (byte-defop-compiler point-max        0)
  2282. (byte-defop-compiler point-min        0)
  2283. (byte-defop-compiler following-char    0)
  2284. (byte-defop-compiler preceding-char    0)
  2285. (byte-defop-compiler current-column    0)
  2286. (byte-defop-compiler eolp        0)
  2287. (byte-defop-compiler eobp        0)
  2288. (byte-defop-compiler bolp        0)
  2289. (byte-defop-compiler bobp        0)
  2290. (byte-defop-compiler current-buffer    0)
  2291. ;;(byte-defop-compiler read-char    0) ;; obsolete
  2292. (byte-defop-compiler interactive-p    0)
  2293. (byte-defop-compiler19 widen        0)
  2294. (byte-defop-compiler19 end-of-line    0-1)
  2295. (byte-defop-compiler19 forward-char   0-1)
  2296. (byte-defop-compiler19 forward-line   0-1)
  2297. (byte-defop-compiler symbolp        1)
  2298. (byte-defop-compiler consp        1)
  2299. (byte-defop-compiler stringp        1)
  2300. (byte-defop-compiler listp        1)
  2301. (byte-defop-compiler not        1)
  2302. (byte-defop-compiler (null byte-not)    1)
  2303. (byte-defop-compiler car        1)
  2304. (byte-defop-compiler cdr        1)
  2305. (byte-defop-compiler length        1)
  2306. (byte-defop-compiler symbol-value    1)
  2307. (byte-defop-compiler symbol-function    1)
  2308. (byte-defop-compiler (1+ byte-add1)    1)
  2309. (byte-defop-compiler (1- byte-sub1)    1)
  2310. (byte-defop-compiler goto-char        1)
  2311. (byte-defop-compiler char-after        1)
  2312. (byte-defop-compiler set-buffer        1)
  2313. ;;(byte-defop-compiler set-mark        1) ;; obsolete
  2314. (byte-defop-compiler19 forward-word    1)
  2315. (byte-defop-compiler19 char-syntax    1)
  2316. (byte-defop-compiler19 nreverse        1)
  2317. (byte-defop-compiler19 car-safe        1)
  2318. (byte-defop-compiler19 cdr-safe        1)
  2319. (byte-defop-compiler19 numberp        1)
  2320. (byte-defop-compiler19 integerp        1)
  2321. (byte-defop-compiler19 skip-chars-forward     1-2)
  2322. (byte-defop-compiler19 skip-chars-backward    1-2)
  2323. (byte-defop-compiler (eql byte-eq)     2)
  2324. (byte-defop-compiler eq          2)
  2325. (byte-defop-compiler memq        2)
  2326. (byte-defop-compiler cons        2)
  2327. (byte-defop-compiler aref        2)
  2328. (byte-defop-compiler set        2)
  2329. (byte-defop-compiler (= byte-eqlsign)    2)
  2330. (byte-defop-compiler (< byte-lss)    2)
  2331. (byte-defop-compiler (> byte-gtr)    2)
  2332. (byte-defop-compiler (<= byte-leq)    2)
  2333. (byte-defop-compiler (>= byte-geq)    2)
  2334. (byte-defop-compiler get        2)
  2335. (byte-defop-compiler nth        2)
  2336. (byte-defop-compiler substring        2-3)
  2337. (byte-defop-compiler19 (move-marker byte-set-marker) 2-3)
  2338. (byte-defop-compiler19 set-marker    2-3)
  2339. (byte-defop-compiler19 match-beginning    1)
  2340. (byte-defop-compiler19 match-end    1)
  2341. (byte-defop-compiler19 upcase        1)
  2342. (byte-defop-compiler19 downcase        1)
  2343. (byte-defop-compiler19 string=        2)
  2344. (byte-defop-compiler19 string<        2)
  2345. (byte-defop-compiler19 (string-equal byte-string=) 2)
  2346. (byte-defop-compiler19 (string-lessp byte-string<) 2)
  2347. (byte-defop-compiler19 equal        2)
  2348. (byte-defop-compiler19 nthcdr        2)
  2349. (byte-defop-compiler19 elt        2)
  2350. (byte-defop-compiler19 member        2)
  2351. (byte-defop-compiler19 assq        2)
  2352. (byte-defop-compiler19 (rplaca byte-setcar) 2)
  2353. (byte-defop-compiler19 (rplacd byte-setcdr) 2)
  2354. (byte-defop-compiler19 setcar        2)
  2355. (byte-defop-compiler19 setcdr        2)
  2356. (byte-defop-compiler19 buffer-substring    2)
  2357. (byte-defop-compiler19 delete-region    2)
  2358. (byte-defop-compiler19 narrow-to-region    2)
  2359. (byte-defop-compiler19 (% byte-rem)    2)
  2360. (byte-defop-compiler aset        3)
  2361.  
  2362. (byte-defop-compiler max        byte-compile-associative)
  2363. (byte-defop-compiler min        byte-compile-associative)
  2364. (byte-defop-compiler (+ byte-plus)    byte-compile-associative)
  2365. (byte-defop-compiler19 (* byte-mult)    byte-compile-associative)
  2366.  
  2367. ;;####(byte-defop-compiler19 move-to-column    1)
  2368. (byte-defop-compiler-1 interactive byte-compile-noop)
  2369.  
  2370.  
  2371. (defun byte-compile-subr-wrong-args (form n)
  2372.   (byte-compile-warn "%s called with %d arg%s, but requires %s"
  2373.              (car form) (length (cdr form))
  2374.              (if (= 1 (length (cdr form))) "" "s") n)
  2375.   ;; get run-time wrong-number-of-args error.
  2376.   (byte-compile-normal-call form))
  2377.  
  2378. (defun byte-compile-no-args (form)
  2379.   (if (not (= (length form) 1))
  2380.       (byte-compile-subr-wrong-args form "none")
  2381.     (byte-compile-out (get (car form) 'byte-opcode) 0)))
  2382.  
  2383. (defun byte-compile-one-arg (form)
  2384.   (if (not (= (length form) 2))
  2385.       (byte-compile-subr-wrong-args form 1)
  2386.     (byte-compile-form (car (cdr form)))  ;; Push the argument
  2387.     (byte-compile-out (get (car form) 'byte-opcode) 0)))
  2388.  
  2389. (defun byte-compile-two-args (form)
  2390.   (if (not (= (length form) 3))
  2391.       (byte-compile-subr-wrong-args form 2)
  2392.     (byte-compile-form (car (cdr form)))  ;; Push the arguments
  2393.     (byte-compile-form (nth 2 form))
  2394.     (byte-compile-out (get (car form) 'byte-opcode) 0)))
  2395.  
  2396. (defun byte-compile-three-args (form)
  2397.   (if (not (= (length form) 4))
  2398.       (byte-compile-subr-wrong-args form 3)
  2399.     (byte-compile-form (car (cdr form)))  ;; Push the arguments
  2400.     (byte-compile-form (nth 2 form))
  2401.     (byte-compile-form (nth 3 form))
  2402.     (byte-compile-out (get (car form) 'byte-opcode) 0)))
  2403.  
  2404. (defun byte-compile-zero-or-one-arg (form)
  2405.   (let ((len (length form)))
  2406.     (cond ((= len 1) (byte-compile-one-arg (append form '(nil))))
  2407.       ((= len 2) (byte-compile-one-arg form))
  2408.       (t (byte-compile-subr-wrong-args form "0-1")))))
  2409.  
  2410. (defun byte-compile-one-or-two-args (form)
  2411.   (let ((len (length form)))
  2412.     (cond ((= len 2) (byte-compile-two-args (append form '(nil))))
  2413.       ((= len 3) (byte-compile-two-args form))
  2414.       (t (byte-compile-subr-wrong-args form "1-2")))))
  2415.  
  2416. (defun byte-compile-two-or-three-args (form)
  2417.   (let ((len (length form)))
  2418.     (cond ((= len 3) (byte-compile-three-args (append form '(nil))))
  2419.       ((= len 4) (byte-compile-three-args form))
  2420.       (t (byte-compile-subr-wrong-args form "2-3")))))
  2421.  
  2422. (defun byte-compile-noop (form)
  2423.   (byte-compile-constant nil))
  2424.  
  2425. (defun byte-compile-discard ()
  2426.   (byte-compile-out 'byte-discard 0))
  2427.  
  2428.  
  2429. ;; Compile a function that accepts one or more args and is right-associative.
  2430. ;; We do it by left-associativity so that the operations
  2431. ;; are done in the same order as in interpreted code.
  2432. (defun byte-compile-associative (form)
  2433.   (if (cdr form)
  2434.       (let ((opcode (get (car form) 'byte-opcode))
  2435.         (args (copy-sequence (cdr form))))
  2436.     (byte-compile-form (car args))
  2437.     (setq args (cdr args))
  2438.     (while args
  2439.       (byte-compile-form (car args))
  2440.       (byte-compile-out opcode 0)
  2441.       (setq args (cdr args))))
  2442.     (byte-compile-constant (eval form))))
  2443.  
  2444.  
  2445. ;; more complicated compiler macros
  2446.  
  2447. (byte-defop-compiler list)
  2448. (byte-defop-compiler concat)
  2449. (byte-defop-compiler fset)
  2450. (byte-defop-compiler (indent-to-column byte-indent-to) byte-compile-indent-to)
  2451. (byte-defop-compiler indent-to)
  2452. (byte-defop-compiler insert)
  2453. (byte-defop-compiler-1 function byte-compile-function-form)
  2454. (byte-defop-compiler-1 - byte-compile-minus)
  2455. (byte-defop-compiler19 (/ byte-quo) byte-compile-quo)
  2456. (byte-defop-compiler19 nconc)
  2457. (byte-defop-compiler-1 beginning-of-line)
  2458.  
  2459. (defun byte-compile-list (form)
  2460.   (let ((count (length (cdr form))))
  2461.     (cond ((= count 0)
  2462.        (byte-compile-constant nil))
  2463.       ((< count 5)
  2464.        (mapcar 'byte-compile-form (cdr form))
  2465.        (byte-compile-out
  2466.         (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- count)) 0))
  2467.       ((and (< count 256) (not (byte-compile-version-cond
  2468.                     byte-compile-compatibility)))
  2469.        (mapcar 'byte-compile-form (cdr form))
  2470.        (byte-compile-out 'byte-listN count))
  2471.       (t (byte-compile-normal-call form)))))
  2472.  
  2473. (defun byte-compile-concat (form)
  2474.   (let ((count (length (cdr form))))
  2475.     (cond ((and (< 1 count) (< count 5))
  2476.        (mapcar 'byte-compile-form (cdr form))
  2477.        (byte-compile-out
  2478.         (aref [byte-concat2 byte-concat3 byte-concat4] (- count 2))
  2479.         0))
  2480.       ;; Concat of one arg is not a no-op if arg is not a string.
  2481.       ((= count 0)
  2482.        (byte-compile-form ""))
  2483.       ((and (< count 256) (not (byte-compile-version-cond
  2484.                     byte-compile-compatibility)))
  2485.        (mapcar 'byte-compile-form (cdr form))
  2486.        (byte-compile-out 'byte-concatN count))
  2487.       ((byte-compile-normal-call form)))))
  2488.  
  2489. (defun byte-compile-minus (form)
  2490.   (if (null (setq form (cdr form)))
  2491.       (byte-compile-constant 0)
  2492.     (byte-compile-form (car form))
  2493.     (if (cdr form)
  2494.     (while (setq form (cdr form))
  2495.       (byte-compile-form (car form))
  2496.       (byte-compile-out 'byte-diff 0))
  2497.       (byte-compile-out 'byte-negate 0))))
  2498.  
  2499. (defun byte-compile-quo (form)
  2500.   (let ((len (length form)))
  2501.     (cond ((<= len 2)
  2502.        (byte-compile-subr-wrong-args form "2 or more"))
  2503.       (t
  2504.        (byte-compile-form (car (setq form (cdr form))))
  2505.        (while (setq form (cdr form))
  2506.          (byte-compile-form (car form))
  2507.          (byte-compile-out 'byte-quo 0))))))
  2508.  
  2509. (defun byte-compile-nconc (form)
  2510.   (let ((len (length form)))
  2511.     (cond ((= len 1)
  2512.        (byte-compile-constant nil))
  2513.       ((= len 2)
  2514.        ;; nconc of one arg is a noop, even if that arg isn't a list.
  2515.        (byte-compile-form (nth 1 form)))
  2516.       (t
  2517.        (byte-compile-form (car (setq form (cdr form))))
  2518.        (while (setq form (cdr form))
  2519.          (byte-compile-form (car form))
  2520.          (byte-compile-out 'byte-nconc 0))))))
  2521.  
  2522. (defun byte-compile-fset (form)
  2523.   ;; warn about forms like (fset 'foo '(lambda () ...))
  2524.   ;; (where the lambda expression is non-trivial...)
  2525.   (let ((fn (nth 2 form))
  2526.     body)
  2527.     (if (and (eq (car-safe fn) 'quote)
  2528.          (eq (car-safe (setq fn (nth 1 fn))) 'lambda))
  2529.     (progn
  2530.       (setq body (cdr (cdr fn)))
  2531.       (if (stringp (car body)) (setq body (cdr body)))
  2532.       (if (eq 'interactive (car-safe (car body))) (setq body (cdr body)))
  2533.       (if (and (consp (car body))
  2534.            (not (eq 'byte-code (car (car body)))))
  2535.           (byte-compile-warn
  2536.       "A quoted lambda form is the second argument of fset.  This is probably
  2537.      not what you want, as that lambda cannot be compiled.  Consider using
  2538.      the syntax (function (lambda (...) ...)) instead.")))))
  2539.   (byte-compile-two-args form))
  2540.  
  2541. (defun byte-compile-funarg (form)
  2542.   ;; (mapcar '(lambda (x) ..) ..) ==> (mapcar (function (lambda (x) ..)) ..)
  2543.   ;; for cases where it's guaranteed that first arg will be used as a lambda.
  2544.   (byte-compile-normal-call
  2545.    (let ((fn (nth 1 form)))
  2546.      (if (and (eq (car-safe fn) 'quote)
  2547.           (eq (car-safe (nth 1 fn)) 'lambda))
  2548.      (cons (car form)
  2549.            (cons (cons 'function (cdr fn))
  2550.              (cdr (cdr form))))
  2551.        form))))
  2552.  
  2553. ;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
  2554. ;; Otherwise it will be incompatible with the interpreter,
  2555. ;; and (funcall (function foo)) will lose with autoloads.
  2556.  
  2557. (defun byte-compile-function-form (form)
  2558.   (byte-compile-constant
  2559.    (cond ((symbolp (nth 1 form))
  2560.       (nth 1 form))
  2561.      ;; If we're not allowed to use #[] syntax, then output a form like
  2562.      ;; '(lambda (..) (byte-code ..)) instead of a call to make-byte-code.
  2563.      ;; In this situation, calling make-byte-code at run-time will usually
  2564.      ;; be less efficient than processing a call to byte-code.
  2565.      ((byte-compile-version-cond byte-compile-compatibility)
  2566.       (byte-compile-byte-code-unmake (byte-compile-lambda (nth 1 form))))
  2567.      ((byte-compile-lambda (nth 1 form))))))
  2568.  
  2569. (defun byte-compile-indent-to (form)
  2570.   (let ((len (length form)))
  2571.     (cond ((= len 2)
  2572.        (byte-compile-form (car (cdr form)))
  2573.        (byte-compile-out 'byte-indent-to 0))
  2574.       ((= len 3)
  2575.        ;; no opcode for 2-arg case.
  2576.        (byte-compile-normal-call form))
  2577.       (t
  2578.        (byte-compile-subr-wrong-args form "1-2")))))
  2579.  
  2580. (defun byte-compile-insert (form)
  2581.   (cond ((null (cdr form))
  2582.      (byte-compile-constant nil))
  2583.     ((and (not (byte-compile-version-cond
  2584.             byte-compile-compatibility))
  2585.           (<= (length form) 256))
  2586.      (mapcar 'byte-compile-form (cdr form))
  2587.      (if (cdr (cdr form))
  2588.          (byte-compile-out 'byte-insertN (length (cdr form)))
  2589.        (byte-compile-out 'byte-insert 0)))
  2590.     ((memq t (mapcar 'consp (cdr (cdr form))))
  2591.      (byte-compile-normal-call form))
  2592.     ;; We can split it; there is no function call after inserting 1st arg.
  2593.     (t
  2594.      (while (setq form (cdr form))
  2595.        (byte-compile-form (car form))
  2596.        (byte-compile-out 'byte-insert 0)
  2597.        (if (cdr form)
  2598.            (byte-compile-discard))))))
  2599.  
  2600. (defun byte-compile-beginning-of-line (form)
  2601.   (if (not (byte-compile-constp (nth 1 form)))
  2602.       (byte-compile-normal-call form)
  2603.     (byte-compile-form
  2604.      (list 'forward-line
  2605.        (if (integerp (setq form (or (eval (nth 1 form)) 1)))
  2606.            (1- form)
  2607.          (byte-compile-warn "Non-numeric arg to beginning-of-line: %s"
  2608.                 form)
  2609.          (list '1- (list 'quote form))))
  2610.      t)
  2611.     (byte-compile-constant nil)))
  2612.  
  2613.  
  2614. (byte-defop-compiler-1 setq)
  2615. (byte-defop-compiler-1 setq-default)
  2616. (byte-defop-compiler-1 quote)
  2617. (byte-defop-compiler-1 quote-form)
  2618.  
  2619. (defun byte-compile-setq (form)
  2620.   (let ((args (cdr form)))
  2621.     (if args
  2622.     (while args
  2623.       (byte-compile-form (car (cdr args)))
  2624.       (or for-effect (cdr (cdr args))
  2625.           (byte-compile-out 'byte-dup 0))
  2626.       (byte-compile-variable-ref 'byte-varset (car args))
  2627.       (setq args (cdr (cdr args))))
  2628.       ;; (setq), with no arguments.
  2629.       (byte-compile-form nil for-effect))
  2630.     (setq for-effect nil)))
  2631.  
  2632. (defun byte-compile-setq-default (form)
  2633.   (let ((args (cdr form))
  2634.     setters)
  2635.     (while args
  2636.       (setq setters
  2637.         (cons (list 'set-default (list 'quote (car args)) (car (cdr args)))
  2638.           setters))
  2639.       (setq args (cdr (cdr args))))
  2640.     (byte-compile-form (cons 'progn (nreverse setters)))))
  2641.  
  2642. (defun byte-compile-quote (form)
  2643.   (byte-compile-constant (car (cdr form))))
  2644.  
  2645. (defun byte-compile-quote-form (form)
  2646.   (byte-compile-constant (byte-compile-top-level (nth 1 form))))
  2647.  
  2648.  
  2649. ;;; control structures
  2650.  
  2651. (defun byte-compile-body (body &optional for-effect)
  2652.   (while (cdr body)
  2653.     (byte-compile-form (car body) t)
  2654.     (setq body (cdr body)))
  2655.   (byte-compile-form (car body) for-effect))
  2656.  
  2657. (defsubst byte-compile-body-do-effect (body)
  2658.   (byte-compile-body body for-effect)
  2659.   (setq for-effect nil))
  2660.  
  2661. (defsubst byte-compile-form-do-effect (form)
  2662.   (byte-compile-form form for-effect)
  2663.   (setq for-effect nil))
  2664.  
  2665. (byte-defop-compiler-1 inline byte-compile-progn)
  2666. (byte-defop-compiler-1 progn)
  2667. (byte-defop-compiler-1 prog1)
  2668. (byte-defop-compiler-1 prog2)
  2669. (byte-defop-compiler-1 if)
  2670. (byte-defop-compiler-1 cond)
  2671. (byte-defop-compiler-1 and)
  2672. (byte-defop-compiler-1 or)
  2673. (byte-defop-compiler-1 while)
  2674. (byte-defop-compiler-1 funcall)
  2675. (byte-defop-compiler-1 apply byte-compile-funarg)
  2676. (byte-defop-compiler-1 mapcar byte-compile-funarg)
  2677. (byte-defop-compiler-1 mapatoms byte-compile-funarg)
  2678. (byte-defop-compiler-1 mapconcat byte-compile-funarg)
  2679. (byte-defop-compiler-1 let)
  2680. (byte-defop-compiler-1 let*)
  2681.  
  2682. (defun byte-compile-progn (form)
  2683.   (byte-compile-body-do-effect (cdr form)))
  2684.  
  2685. (defun byte-compile-prog1 (form)
  2686.   (byte-compile-form-do-effect (car (cdr form)))
  2687.   (byte-compile-body (cdr (cdr form)) t))
  2688.  
  2689. (defun byte-compile-prog2 (form)
  2690.   (byte-compile-form (nth 1 form) t)
  2691.   (byte-compile-form-do-effect (nth 2 form))
  2692.   (byte-compile-body (cdr (cdr (cdr form))) t))
  2693.  
  2694. (defmacro byte-compile-goto-if (cond discard tag)
  2695.   (` (byte-compile-goto
  2696.       (if (, cond)
  2697.       (if (, discard) 'byte-goto-if-not-nil 'byte-goto-if-not-nil-else-pop)
  2698.     (if (, discard) 'byte-goto-if-nil 'byte-goto-if-nil-else-pop))
  2699.       (, tag))))
  2700.  
  2701. (defun byte-compile-if (form)
  2702.   (byte-compile-form (car (cdr form)))
  2703.   (if (null (nthcdr 3 form))
  2704.       ;; No else-forms
  2705.       (let ((donetag (byte-compile-make-tag)))
  2706.     (byte-compile-goto-if nil for-effect donetag)
  2707.     (byte-compile-form (nth 2 form) for-effect)
  2708.     (byte-compile-out-tag donetag))
  2709.     (let ((donetag (byte-compile-make-tag)) (elsetag (byte-compile-make-tag)))
  2710.       (byte-compile-goto 'byte-goto-if-nil elsetag)
  2711.       (byte-compile-form (nth 2 form) for-effect)
  2712.       (byte-compile-goto 'byte-goto donetag)
  2713.       (byte-compile-out-tag elsetag)
  2714.       (byte-compile-body (cdr (cdr (cdr form))) for-effect)
  2715.       (byte-compile-out-tag donetag)))
  2716.   (setq for-effect nil))
  2717.  
  2718. (defun byte-compile-cond (clauses)
  2719.   (let ((donetag (byte-compile-make-tag))
  2720.     nexttag clause)
  2721.     (while (setq clauses (cdr clauses))
  2722.       (setq clause (car clauses))
  2723.       (cond ((or (eq (car clause) t)
  2724.          (and (eq (car-safe (car clause)) 'quote)
  2725.               (car-safe (cdr-safe (car clause)))))
  2726.          ;; Unconditional clause
  2727.          (setq clause (cons t clause)
  2728.            clauses nil))
  2729.         ((cdr clauses)
  2730.          (byte-compile-form (car clause))
  2731.          (if (null (cdr clause))
  2732.          ;; First clause is a singleton.
  2733.          (byte-compile-goto-if t for-effect donetag)
  2734.            (setq nexttag (byte-compile-make-tag))
  2735.            (byte-compile-goto 'byte-goto-if-nil nexttag)
  2736.            (byte-compile-body (cdr clause) for-effect)
  2737.            (byte-compile-goto 'byte-goto donetag)
  2738.            (byte-compile-out-tag nexttag)))))
  2739.     ;; Last clause
  2740.     (and (cdr clause) (not (eq (car clause) t))
  2741.      (progn (byte-compile-form (car clause))
  2742.         (byte-compile-goto-if nil for-effect donetag)
  2743.         (setq clause (cdr clause))))
  2744.     (byte-compile-body-do-effect clause)
  2745.     (byte-compile-out-tag donetag)))
  2746.  
  2747. (defun byte-compile-and (form)
  2748.   (let ((failtag (byte-compile-make-tag))
  2749.     (args (cdr form)))
  2750.     (if (null args)
  2751.     (byte-compile-form-do-effect t)
  2752.       (while (cdr args)
  2753.     (byte-compile-form (car args))
  2754.     (byte-compile-goto-if nil for-effect failtag)
  2755.     (setq args (cdr args)))
  2756.       (byte-compile-form-do-effect (car args))
  2757.       (byte-compile-out-tag failtag))))
  2758.  
  2759. (defun byte-compile-or (form)
  2760.   (let ((wintag (byte-compile-make-tag))
  2761.     (args (cdr form)))
  2762.     (if (null args)
  2763.     (byte-compile-form-do-effect nil)
  2764.       (while (cdr args)
  2765.     (byte-compile-form (car args))
  2766.     (byte-compile-goto-if t for-effect wintag)
  2767.     (setq args (cdr args)))
  2768.       (byte-compile-form-do-effect (car args))
  2769.       (byte-compile-out-tag wintag))))
  2770.  
  2771. (defun byte-compile-while (form)
  2772.   (let ((endtag (byte-compile-make-tag))
  2773.     (looptag (byte-compile-make-tag)))
  2774.     (byte-compile-out-tag looptag)
  2775.     (byte-compile-form (car (cdr form)))
  2776.     (byte-compile-goto-if nil for-effect endtag)
  2777.     (byte-compile-body (cdr (cdr form)) t)
  2778.     (byte-compile-goto 'byte-goto looptag)
  2779.     (byte-compile-out-tag endtag)
  2780.     (setq for-effect nil)))
  2781.  
  2782. (defun byte-compile-funcall (form)
  2783.   (mapcar 'byte-compile-form (cdr form))
  2784.   (byte-compile-out 'byte-call (length (cdr (cdr form)))))
  2785.  
  2786.  
  2787. (defun byte-compile-let (form)
  2788.   ;; First compute the binding values in the old scope.
  2789.   (let ((varlist (car (cdr form))))
  2790.     (while varlist
  2791.       (if (consp (car varlist))
  2792.       (byte-compile-form (car (cdr (car varlist))))
  2793.     (byte-compile-push-constant nil))
  2794.       (setq varlist (cdr varlist))))
  2795.   (let ((byte-compile-bound-variables byte-compile-bound-variables) ;new scope
  2796.     (varlist (reverse (car (cdr form)))))
  2797.     (while varlist
  2798.       (byte-compile-variable-ref 'byte-varbind (if (consp (car varlist))
  2799.                            (car (car varlist))
  2800.                          (car varlist)))
  2801.       (setq varlist (cdr varlist)))
  2802.     (byte-compile-body-do-effect (cdr (cdr form)))
  2803.     (byte-compile-out 'byte-unbind (length (car (cdr form))))))
  2804.  
  2805. (defun byte-compile-let* (form)
  2806.   (let ((byte-compile-bound-variables byte-compile-bound-variables) ;new scope
  2807.     (varlist (copy-sequence (car (cdr form)))))
  2808.     (while varlist
  2809.       (if (atom (car varlist))
  2810.       (byte-compile-push-constant nil)
  2811.     (byte-compile-form (car (cdr (car varlist))))
  2812.     (setcar varlist (car (car varlist))))
  2813.       (byte-compile-variable-ref 'byte-varbind (car varlist))
  2814.       (setq varlist (cdr varlist)))
  2815.     (byte-compile-body-do-effect (cdr (cdr form)))
  2816.     (byte-compile-out 'byte-unbind (length (car (cdr form))))))
  2817.  
  2818.  
  2819. (byte-defop-compiler-1 /= byte-compile-negated)
  2820. (byte-defop-compiler-1 atom byte-compile-negated)
  2821. (byte-defop-compiler-1 nlistp byte-compile-negated)
  2822.  
  2823. (put '/= 'byte-compile-negated-op '=)
  2824. (put 'atom 'byte-compile-negated-op 'consp)
  2825. (put 'nlistp 'byte-compile-negated-op 'listp)
  2826.  
  2827. (defun byte-compile-negated (form)
  2828.   (byte-compile-form-do-effect (byte-compile-negation-optimizer form)))
  2829.  
  2830. ;; Even when optimization is off, /= is optimized to (not (= ...)).
  2831. (defun byte-compile-negation-optimizer (form)
  2832.   ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
  2833.   (list 'not
  2834.     (cons (or (get (car form) 'byte-compile-negated-op)
  2835.           (error
  2836.            "Compiler error: `%s' has no `byte-compile-negated-op' property"
  2837.            (car form)))
  2838.       (cdr form))))
  2839.  
  2840. ;;; other tricky macro-like special-forms
  2841.  
  2842. (byte-defop-compiler-1 catch)
  2843. (byte-defop-compiler-1 unwind-protect)
  2844. (byte-defop-compiler-1 condition-case)
  2845. (byte-defop-compiler-1 save-excursion)
  2846. (byte-defop-compiler-1 save-restriction)
  2847. (byte-defop-compiler-1 save-window-excursion)
  2848. (byte-defop-compiler-1 with-output-to-temp-buffer)
  2849. (byte-defop-compiler-1 track-mouse)
  2850.  
  2851. (defun byte-compile-catch (form)
  2852.   (byte-compile-form (car (cdr form)))
  2853.   (byte-compile-push-constant
  2854.     (byte-compile-top-level (cons 'progn (cdr (cdr form))) for-effect))
  2855.   (byte-compile-out 'byte-catch 0))
  2856.  
  2857. (defun byte-compile-unwind-protect (form)
  2858.   (byte-compile-push-constant
  2859.    (byte-compile-top-level-body (cdr (cdr form)) t))
  2860.   (byte-compile-out 'byte-unwind-protect 0)
  2861.   (byte-compile-form-do-effect (car (cdr form)))
  2862.   (byte-compile-out 'byte-unbind 1))
  2863.  
  2864. (defun byte-compile-track-mouse (form)
  2865.   (byte-compile-form
  2866.    (list
  2867.     'funcall
  2868.     (list 'quote
  2869.       (list 'lambda nil
  2870.         (cons 'track-mouse
  2871.               (byte-compile-top-level-body (cdr form))))))))
  2872.  
  2873. (defun byte-compile-condition-case (form)
  2874.   (let* ((var (nth 1 form))
  2875.      (byte-compile-bound-variables
  2876.       (if var (cons var byte-compile-bound-variables)
  2877.         byte-compile-bound-variables)))
  2878.     (or (symbolp var)
  2879.     (byte-compile-warn
  2880.      "%s is not a variable-name or nil (in condition-case)" var))
  2881.     (byte-compile-push-constant var)
  2882.     (byte-compile-push-constant (byte-compile-top-level
  2883.                  (nth 2 form) for-effect))
  2884.     (let ((clauses (cdr (cdr (cdr form))))
  2885.       compiled-clauses)
  2886.       (while clauses
  2887.     (let* ((clause (car clauses))
  2888.                (condition (car clause)))
  2889.           (cond ((not (or (symbolp condition)
  2890.               (and (listp condition)
  2891.                    (let ((syms condition) (ok t))
  2892.                  (while syms
  2893.                    (if (not (symbolp (car syms)))
  2894.                        (setq ok nil))
  2895.                    (setq syms (cdr syms)))
  2896.                  ok))))
  2897.                  (byte-compile-warn
  2898.                    "%s is not a condition name or list of such (in condition-case)"
  2899.                    (prin1-to-string condition)))
  2900. ;;                ((not (or (eq condition 't)
  2901. ;;              (and (stringp (get condition 'error-message))
  2902. ;;                   (consp (get condition 'error-conditions)))))
  2903. ;;                 (byte-compile-warn
  2904. ;;                   "%s is not a known condition name (in condition-case)" 
  2905. ;;                   condition))
  2906.         )
  2907.       (setq compiled-clauses
  2908.         (cons (cons condition
  2909.                 (byte-compile-top-level-body
  2910.                  (cdr clause) for-effect))
  2911.               compiled-clauses)))
  2912.     (setq clauses (cdr clauses)))
  2913.       (byte-compile-push-constant (nreverse compiled-clauses)))
  2914.     (byte-compile-out 'byte-condition-case 0)))
  2915.  
  2916.  
  2917. (defun byte-compile-save-excursion (form)
  2918.   (byte-compile-out 'byte-save-excursion 0)
  2919.   (byte-compile-body-do-effect (cdr form))
  2920.   (byte-compile-out 'byte-unbind 1))
  2921.  
  2922. (defun byte-compile-save-restriction (form)
  2923.   (byte-compile-out 'byte-save-restriction 0)
  2924.   (byte-compile-body-do-effect (cdr form))
  2925.   (byte-compile-out 'byte-unbind 1))
  2926.  
  2927. (defun byte-compile-save-window-excursion (form)
  2928.   (byte-compile-push-constant
  2929.    (byte-compile-top-level-body (cdr form) for-effect))
  2930.   (byte-compile-out 'byte-save-window-excursion 0))
  2931.  
  2932. (defun byte-compile-with-output-to-temp-buffer (form)
  2933.   (byte-compile-form (car (cdr form)))
  2934.   (byte-compile-out 'byte-temp-output-buffer-setup 0)
  2935.   (byte-compile-body (cdr (cdr form)))
  2936.   (byte-compile-out 'byte-temp-output-buffer-show 0))
  2937.  
  2938.  
  2939. ;;; top-level forms elsewhere
  2940.  
  2941. (byte-defop-compiler-1 defun)
  2942. (byte-defop-compiler-1 defmacro)
  2943. (byte-defop-compiler-1 defvar)
  2944. (byte-defop-compiler-1 defconst byte-compile-defvar)
  2945. (byte-defop-compiler-1 autoload)
  2946. (byte-defop-compiler-1 lambda byte-compile-lambda-form)
  2947. (byte-defop-compiler-1 defalias)
  2948.  
  2949. (defun byte-compile-defun (form)
  2950.   ;; This is not used for file-level defuns with doc strings.
  2951.   (byte-compile-two-args ; Use this to avoid byte-compile-fset's warning.
  2952.    (list 'fset (list 'quote (nth 1 form))
  2953.      (byte-compile-byte-code-maker
  2954.       (byte-compile-lambda (cons 'lambda (cdr (cdr form)))))))
  2955.   (byte-compile-discard)
  2956.   (byte-compile-constant (nth 1 form)))
  2957.  
  2958. (defun byte-compile-defmacro (form)
  2959.   ;; This is not used for file-level defmacros with doc strings.
  2960.   (byte-compile-body-do-effect
  2961.    (list (list 'fset (list 'quote (nth 1 form))
  2962.            (let ((code (byte-compile-byte-code-maker
  2963.                 (byte-compile-lambda
  2964.                  (cons 'lambda (cdr (cdr form)))))))
  2965.          (if (eq (car-safe code) 'make-byte-code)
  2966.              (list 'cons ''macro code)
  2967.            (list 'quote (cons 'macro (eval code))))))
  2968.      (list 'quote (nth 1 form)))))
  2969.  
  2970. (defun byte-compile-defvar (form)
  2971.   ;; This is not used for file-level defvar/consts with doc strings.
  2972.   (let ((var (nth 1 form))
  2973.     (value (nth 2 form))
  2974.     (string (nth 3 form)))
  2975.     (if (memq 'free-vars byte-compile-warnings)
  2976.     (setq byte-compile-bound-variables
  2977.           (cons var byte-compile-bound-variables)))
  2978.     (byte-compile-body-do-effect
  2979.      (list (if (cdr (cdr form))
  2980.            (if (eq (car form) 'defconst)
  2981.            (list 'setq var value)
  2982.          (list 'or (list 'boundp (list 'quote var))
  2983.                (list 'setq var value))))
  2984.        ;; Put the defined variable in this library's load-history entry
  2985.        ;; just as a real defvar would.
  2986.        (list 'setq 'current-load-list
  2987.          (list 'cons (list 'quote var)
  2988.                'current-load-list))
  2989.        (if string 
  2990.            (list 'put (list 'quote var) ''variable-documentation string))
  2991.        (list 'quote var)))))
  2992.  
  2993. (defun byte-compile-autoload (form)
  2994.   (and (byte-compile-constp (nth 1 form))
  2995.        (byte-compile-constp (nth 5 form))
  2996.        (eval (nth 5 form))  ; macro-p
  2997.        (not (fboundp (eval (nth 1 form))))
  2998.        (byte-compile-warn
  2999.     "The compiler ignores `autoload' except at top level.  You should 
  3000.      probably put the autoload of the macro `%s' at top-level."
  3001.     (eval (nth 1 form))))
  3002.   (byte-compile-normal-call form))
  3003.  
  3004. ;; Lambda's in valid places are handled as special cases by various code.
  3005. ;; The ones that remain are errors.
  3006. (defun byte-compile-lambda-form (form)
  3007.   (error "`lambda' used as function name is invalid"))
  3008.  
  3009. ;; Compile normally, but deal with warnings for the function being defined.
  3010. (defun byte-compile-defalias (form)
  3011.   (if (and (consp (cdr form)) (consp (nth 1 form))
  3012.        (eq (car (nth 1 form)) 'quote)
  3013.        (consp (cdr (nth 1 form)))
  3014.        (symbolp (nth 1 (nth 1 form)))
  3015.        (consp (nthcdr 2 form))
  3016.        (consp (nth 2 form))
  3017.        (eq (car (nth 2 form)) 'quote)
  3018.        (consp (cdr (nth 2 form)))
  3019.        (symbolp (nth 1 (nth 2 form))))
  3020.       (progn
  3021.     (byte-compile-defalias-warn (nth 1 (nth 1 form))
  3022.                     (nth 1 (nth 2 form)))
  3023.     (setq byte-compile-function-environment
  3024.           (cons (cons (nth 1 (nth 1 form))
  3025.               (nth 1 (nth 2 form)))
  3026.             byte-compile-function-environment))))
  3027.   (byte-compile-normal-call form))
  3028.  
  3029. ;; Turn off warnings about prior calls to the function being defalias'd.
  3030. ;; This could be smarter and compare those calls with
  3031. ;; the function it is being aliased to.
  3032. (defun byte-compile-defalias-warn (new alias)
  3033.   (let ((calls (assq new byte-compile-unresolved-functions)))
  3034.     (if calls
  3035.     (setq byte-compile-unresolved-functions
  3036.           (delq calls byte-compile-unresolved-functions)))))
  3037.  
  3038. ;;; tags
  3039.  
  3040. ;; Note: Most operations will strip off the 'TAG, but it speeds up
  3041. ;; optimization to have the 'TAG as a part of the tag.
  3042. ;; Tags will be (TAG . (tag-number . stack-depth)).
  3043. (defun byte-compile-make-tag ()
  3044.   (list 'TAG (setq byte-compile-tag-number (1+ byte-compile-tag-number))))
  3045.  
  3046.  
  3047. (defun byte-compile-out-tag (tag)
  3048.   (setq byte-compile-output (cons tag byte-compile-output))
  3049.   (if (cdr (cdr tag))
  3050.       (progn
  3051.     ;; ## remove this someday
  3052.     (and byte-compile-depth
  3053.       (not (= (cdr (cdr tag)) byte-compile-depth))
  3054.       (error "Compiler bug: depth conflict at tag %d" (car (cdr tag))))
  3055.     (setq byte-compile-depth (cdr (cdr tag))))
  3056.     (setcdr (cdr tag) byte-compile-depth)))
  3057.  
  3058. (defun byte-compile-goto (opcode tag)
  3059.   (setq byte-compile-output (cons (cons opcode tag) byte-compile-output))
  3060.   (setcdr (cdr tag) (if (memq opcode byte-goto-always-pop-ops)
  3061.             (1- byte-compile-depth)
  3062.               byte-compile-depth))
  3063.   (setq byte-compile-depth (and (not (eq opcode 'byte-goto))
  3064.                 (1- byte-compile-depth))))
  3065.  
  3066. (defun byte-compile-out (opcode offset)
  3067.   (setq byte-compile-output (cons (cons opcode offset) byte-compile-output))
  3068.   (cond ((eq opcode 'byte-call)
  3069.      (setq byte-compile-depth (- byte-compile-depth offset)))
  3070.     ((eq opcode 'byte-return)
  3071.      ;; This is actually an unnecessary case, because there should be
  3072.      ;; no more opcodes behind byte-return.
  3073.      (setq byte-compile-depth nil))
  3074.     (t
  3075.      (setq byte-compile-depth (+ byte-compile-depth
  3076.                      (or (aref byte-stack+-info
  3077.                            (symbol-value opcode))
  3078.                      (- (1- offset))))
  3079.            byte-compile-maxdepth (max byte-compile-depth
  3080.                       byte-compile-maxdepth))))
  3081.   ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
  3082.   )
  3083.  
  3084.  
  3085. ;;; call tree stuff
  3086.  
  3087. (defun byte-compile-annotate-call-tree (form)
  3088.   (let (entry)
  3089.     ;; annotate the current call
  3090.     (if (setq entry (assq (car form) byte-compile-call-tree))
  3091.     (or (memq byte-compile-current-form (nth 1 entry)) ;callers
  3092.         (setcar (cdr entry)
  3093.             (cons byte-compile-current-form (nth 1 entry))))
  3094.       (setq byte-compile-call-tree
  3095.         (cons (list (car form) (list byte-compile-current-form) nil)
  3096.           byte-compile-call-tree)))
  3097.     ;; annotate the current function
  3098.     (if (setq entry (assq byte-compile-current-form byte-compile-call-tree))
  3099.     (or (memq (car form) (nth 2 entry)) ;called
  3100.         (setcar (cdr (cdr entry))
  3101.             (cons (car form) (nth 2 entry))))
  3102.       (setq byte-compile-call-tree
  3103.         (cons (list byte-compile-current-form nil (list (car form)))
  3104.           byte-compile-call-tree)))
  3105.     ))
  3106.  
  3107. ;; Renamed from byte-compile-report-call-tree
  3108. ;; to avoid interfering with completion of byte-compile-file.
  3109. ;;;###autoload
  3110. (defun display-call-tree (&optional filename)
  3111.   "Display a call graph of a specified file.
  3112. This lists which functions have been called, what functions called
  3113. them, and what functions they call.  The list includes all functions
  3114. whose definitions have been compiled in this Emacs session, as well as
  3115. all functions called by those functions.
  3116.  
  3117. The call graph does not include macros, inline functions, or
  3118. primitives that the byte-code interpreter knows about directly \(eq,
  3119. cons, etc.\).
  3120.  
  3121. The call tree also lists those functions which are not known to be called
  3122. \(that is, to which no calls have been compiled\), and which cannot be
  3123. invoked interactively."
  3124.   (interactive)
  3125.   (message "Generating call tree...")
  3126.   (with-output-to-temp-buffer "*Call-Tree*"
  3127.     (set-buffer "*Call-Tree*")
  3128.     (erase-buffer)
  3129.     (message "Generating call tree... (sorting on %s)"
  3130.          byte-compile-call-tree-sort)
  3131.     (insert "Call tree for "
  3132.         (cond ((null byte-compile-current-file) (or filename "???"))
  3133.           ((stringp byte-compile-current-file)
  3134.            byte-compile-current-file)
  3135.           (t (buffer-name byte-compile-current-file)))
  3136.         " sorted on "
  3137.         (prin1-to-string byte-compile-call-tree-sort)
  3138.         ":\n\n")
  3139.     (if byte-compile-call-tree-sort
  3140.     (setq byte-compile-call-tree
  3141.           (sort byte-compile-call-tree
  3142.             (cond ((eq byte-compile-call-tree-sort 'callers)
  3143.                (function (lambda (x y) (< (length (nth 1 x))
  3144.                               (length (nth 1 y))))))
  3145.               ((eq byte-compile-call-tree-sort 'calls)
  3146.                (function (lambda (x y) (< (length (nth 2 x))
  3147.                               (length (nth 2 y))))))
  3148.               ((eq byte-compile-call-tree-sort 'calls+callers)
  3149.                (function (lambda (x y) (< (+ (length (nth 1 x))
  3150.                              (length (nth 2 x)))
  3151.                               (+ (length (nth 1 y))
  3152.                              (length (nth 2 y)))))))
  3153.               ((eq byte-compile-call-tree-sort 'name)
  3154.                (function (lambda (x y) (string< (car x)
  3155.                                 (car y)))))
  3156.               (t (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
  3157.                     byte-compile-call-tree-sort))))))
  3158.     (message "Generating call tree...")
  3159.     (let ((rest byte-compile-call-tree)
  3160.       (b (current-buffer))
  3161.       f p
  3162.       callers calls)
  3163.       (while rest
  3164.     (prin1 (car (car rest)) b)
  3165.     (setq callers (nth 1 (car rest))
  3166.           calls (nth 2 (car rest)))
  3167.     (insert "\t"
  3168.       (cond ((not (fboundp (setq f (car (car rest)))))
  3169.          (if (null f)
  3170.              " <top level>";; shouldn't insert nil then, actually -sk
  3171.            " <not defined>"))
  3172.         ((subrp (setq f (symbol-function f)))
  3173.          " <subr>")
  3174.         ((symbolp f)
  3175.          (format " ==> %s" f))
  3176.         ((byte-code-function-p f)
  3177.          "<compiled function>")
  3178.         ((not (consp f))
  3179.          "<malformed function>")
  3180.         ((eq 'macro (car f))
  3181.          (if (or (byte-code-function-p (cdr f))
  3182.              (assq 'byte-code (cdr (cdr (cdr f)))))
  3183.              " <compiled macro>"
  3184.            " <macro>"))
  3185.         ((assq 'byte-code (cdr (cdr f)))
  3186.          "<compiled lambda>")
  3187.         ((eq 'lambda (car f))
  3188.          "<function>")
  3189.         (t "???"))
  3190.       (format " (%d callers + %d calls = %d)"
  3191.           ;; Does the optimizer eliminate common subexpressions?-sk
  3192.           (length callers)
  3193.           (length calls)
  3194.           (+ (length callers) (length calls)))
  3195.       "\n")
  3196.     (if callers
  3197.         (progn
  3198.           (insert "  called by:\n")
  3199.           (setq p (point))
  3200.           (insert "    " (if (car callers)
  3201.                  (mapconcat 'symbol-name callers ", ")
  3202.                    "<top level>"))
  3203.           (let ((fill-prefix "    "))
  3204.         (fill-region-as-paragraph p (point)))))
  3205.     (if calls
  3206.         (progn
  3207.           (insert "  calls:\n")
  3208.           (setq p (point))
  3209.           (insert "    " (mapconcat 'symbol-name calls ", "))
  3210.           (let ((fill-prefix "    "))
  3211.         (fill-region-as-paragraph p (point)))))
  3212.     (insert "\n")
  3213.     (setq rest (cdr rest)))
  3214.  
  3215.       (message "Generating call tree...(finding uncalled functions...)")
  3216.       (setq rest byte-compile-call-tree)
  3217.       (let ((uncalled nil))
  3218.     (while rest
  3219.       (or (nth 1 (car rest))
  3220.           (null (setq f (car (car rest))))
  3221.           (byte-compile-fdefinition f t)
  3222.           (commandp (byte-compile-fdefinition f nil))
  3223.           (setq uncalled (cons f uncalled)))
  3224.       (setq rest (cdr rest)))
  3225.     (if uncalled
  3226.         (let ((fill-prefix "  "))
  3227.           (insert "Noninteractive functions not known to be called:\n  ")
  3228.           (setq p (point))
  3229.           (insert (mapconcat 'symbol-name (nreverse uncalled) ", "))
  3230.           (fill-region-as-paragraph p (point)))))
  3231.       )
  3232.     (message "Generating call tree...done.")
  3233.     ))
  3234.  
  3235.  
  3236. ;;; by crl@newton.purdue.edu
  3237. ;;;  Only works noninteractively.
  3238. ;;;###autoload
  3239. (defun batch-byte-compile ()
  3240.   "Run `byte-compile-file' on the files remaining on the command line.
  3241. Use this from the command line, with `-batch';
  3242. it won't work in an interactive Emacs.
  3243. Each file is processed even if an error occurred previously.
  3244. For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\""
  3245.   ;; command-line-args-left is what is left of the command line (from startup.el)
  3246.   (defvar command-line-args-left)    ;Avoid 'free variable' warning
  3247.   (if (not noninteractive)
  3248.       (error "`batch-byte-compile' is to be used only with -batch"))
  3249.   (let ((error nil))
  3250.     (while command-line-args-left
  3251.       (if (file-directory-p (expand-file-name (car command-line-args-left)))
  3252.       (let ((files (directory-files (car command-line-args-left)))
  3253.         source dest)
  3254.         (while files
  3255.           (if (and (string-match emacs-lisp-file-regexp (car files))
  3256.                (not (auto-save-file-name-p (car files)))
  3257.                (setq source (expand-file-name (car files)
  3258.                               (car command-line-args-left)))
  3259.                (setq dest (byte-compile-dest-file source))
  3260.                (file-exists-p dest)
  3261.                (file-newer-than-file-p source dest))
  3262.           (if (null (batch-byte-compile-file source))
  3263.               (setq error t)))
  3264.           (setq files (cdr files))))
  3265.     (if (null (batch-byte-compile-file (car command-line-args-left)))
  3266.         (setq error t)))
  3267.       (setq command-line-args-left (cdr command-line-args-left)))
  3268.     (message "Done")
  3269.     (kill-emacs (if error 1 0))))
  3270.  
  3271. (defun batch-byte-compile-file (file)
  3272.   (condition-case err
  3273.       (progn (byte-compile-file file) t)
  3274.     (error
  3275.      (message (if (cdr err)
  3276.           ">>Error occurred processing %s: %s (%s)"
  3277.           ">>Error occurred processing %s: %s")
  3278.           file
  3279.           (get (car err) 'error-message)
  3280.           (prin1-to-string (cdr err)))
  3281.      nil)))
  3282.  
  3283. ;;;###autoload
  3284. (defun batch-byte-recompile-directory ()
  3285.   "Runs `byte-recompile-directory' on the dirs remaining on the command line.
  3286. Must be used only with `-batch', and kills Emacs on completion.
  3287. For example, invoke `emacs -batch -f batch-byte-recompile-directory .'."
  3288.   ;; command-line-args-left is what is left of the command line (startup.el)
  3289.   (defvar command-line-args-left)    ;Avoid 'free variable' warning
  3290.   (if (not noninteractive)
  3291.       (error "batch-byte-recompile-directory is to be used only with -batch"))
  3292.   (or command-line-args-left
  3293.       (setq command-line-args-left '(".")))
  3294.   (while command-line-args-left
  3295.     (byte-recompile-directory (car command-line-args-left))
  3296.     (setq command-line-args-left (cdr command-line-args-left)))
  3297.   (kill-emacs 0))
  3298.  
  3299.  
  3300. (make-obsolete 'dot 'point)
  3301. (make-obsolete 'dot-max 'point-max)
  3302. (make-obsolete 'dot-min 'point-min)
  3303. (make-obsolete 'dot-marker 'point-marker)
  3304.  
  3305. (make-obsolete 'buffer-flush-undo 'buffer-disable-undo)
  3306. (make-obsolete 'baud-rate "use the baud-rate variable instead")
  3307. (make-obsolete 'compiled-function-p 'byte-code-function-p)
  3308. (make-obsolete-variable 'auto-fill-hook 'auto-fill-function)
  3309. (make-obsolete-variable 'blink-paren-hook 'blink-paren-function)
  3310. (make-obsolete-variable 'lisp-indent-hook 'lisp-indent-function)
  3311. (make-obsolete-variable 'temp-buffer-show-hook
  3312.             'temp-buffer-show-function)
  3313. (make-obsolete-variable 'inhibit-local-variables
  3314.         "use enable-local-variables (with the reversed sense).")
  3315. (make-obsolete-variable 'unread-command-char
  3316.   "use unread-command-events instead.  That variable is a list of events to reread, so it now uses nil to mean `no event', instead of -1.")
  3317. (make-obsolete-variable 'unread-command-event
  3318.   "use unread-command-events; which is a list of events rather than a single event.")
  3319. (make-obsolete-variable 'suspend-hooks 'suspend-hook)
  3320. (make-obsolete-variable 'comment-indent-hook 'comment-indent-function)
  3321. (make-obsolete-variable 'meta-flag "Use the set-input-mode function instead.")
  3322. (make-obsolete-variable 'executing-macro 'executing-kbd-macro)
  3323. (make-obsolete-variable 'before-change-function
  3324.   "use before-change-functions; which is a list of functions rather than a single function.")
  3325. (make-obsolete-variable 'after-change-function
  3326.   "use after-change-functions; which is a list of functions rather than a single function.")
  3327. (make-obsolete-variable 'font-lock-doc-string-face 'font-lock-string-face)
  3328. (make-obsolete-variable 'post-command-idle-hook
  3329.   "use timers instead, with `run-with-idle-timer'.")
  3330. (make-obsolete-variable 'post-command-idle-delay
  3331.   "use timers instead, with `run-with-idle-timer'.")
  3332.  
  3333. (provide 'byte-compile)
  3334. (provide 'bytecomp)
  3335.  
  3336.  
  3337. ;;; report metering (see the hacks in bytecode.c)
  3338.  
  3339. (defun byte-compile-report-ops ()
  3340.   (defvar byte-code-meter)
  3341.   (with-output-to-temp-buffer "*Meter*"
  3342.     (set-buffer "*Meter*")
  3343.     (let ((i 0) n op off)
  3344.       (while (< i 256)
  3345.     (setq n (aref (aref byte-code-meter 0) i)
  3346.           off nil)
  3347.     (if t                ;(not (zerop n))
  3348.         (progn
  3349.           (setq op i)
  3350.           (setq off nil)
  3351.           (cond ((< op byte-nth)
  3352.              (setq off (logand op 7))
  3353.              (setq op (logand op 248)))
  3354.             ((>= op byte-constant)
  3355.              (setq off (- op byte-constant)
  3356.                op byte-constant)))
  3357.           (setq op (aref byte-code-vector op))
  3358.           (insert (format "%-4d" i))
  3359.           (insert (symbol-name op))
  3360.           (if off (insert " [" (int-to-string off) "]"))
  3361.           (indent-to 40)
  3362.           (insert (int-to-string n) "\n")))
  3363.     (setq i (1+ i))))))
  3364.  
  3365. ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
  3366. ;; itself, compile some of its most used recursive functions (at load time).
  3367. ;;
  3368. (eval-when-compile
  3369.   (or (byte-code-function-p (symbol-function 'byte-compile-form))
  3370.       (assq 'byte-code (symbol-function 'byte-compile-form))
  3371.       (let ((byte-optimize nil)        ; do it fast
  3372.         (byte-compile-warnings nil))
  3373.     (mapcar '(lambda (x)
  3374.            (or noninteractive (message "compiling %s..." x))
  3375.            (byte-compile x)
  3376.            (or noninteractive (message "compiling %s...done" x)))
  3377.         '(byte-compile-normal-call
  3378.           byte-compile-form
  3379.           byte-compile-body
  3380.           ;; Inserted some more than necessary, to speed it up.
  3381.           byte-compile-top-level
  3382.           byte-compile-out-toplevel
  3383.           byte-compile-constant
  3384.           byte-compile-variable-ref))))
  3385.   nil)
  3386.  
  3387. ;;; bytecomp.el ends here
  3388.